-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #38 from placetopay-org/feature/gateway-doc
Feature/gateway doc
- Loading branch information
Showing
48 changed files
with
9,940 additions
and
9 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| # Airlines | ||
|
|
||
| ## Codes | ||
|
|
||
| When dispersion transactions are made to airlines, these are the agreement codes for each of them. | ||
|
|
||
| Code | Airline | ||
| -------|---------- | ||
| 2 | AIR CANADA Internacional | ||
| 6 | AEROL. ARGENTINAS Internacional | ||
| 7 | SERVINCLUIDOS Nacional | ||
| 8 | SERVINCLUIDOS Internacional | ||
| 10 | AEROGAL Internacional | ||
| 11 | COPA DOMESTICO Nacional | ||
| 18 | AIR FRANCE Internacional | ||
| 23 | SATENA VISA DISTRIBUCION Nacional | ||
| 26 | American Airlines | ||
| 29 | AVIANCA Nacional | ||
| 30 | AVIANCA Internacional | ||
| 31 | MAYATUR Nacional | ||
| 32 | MAYATUR Internacional | ||
| 33 | COPA INTERNACIONAL | ||
| 36 | CUBANA DE AVIACION Internacional | ||
| 38 | IBERIA Internacional | ||
| 40 | QANTAS Internacional | ||
| 42 | LACSA Internacional | ||
| 43 | OCTOPUS TRAVEL Nacional | ||
| 44 | OCTOPUS TRAVEL Internacional | ||
| 45 | EASYFLY Nacional | ||
| 50 | SANTA BARBARA AIRLINES Internacional | ||
| 53 | SATENA Nacional | ||
| 56 | DUTCH ANTILLES EXPR Internacional | ||
| 58 | VARIG Internacional | ||
| 63 | AVIANCA DESKUBRA Nacional | ||
| 64 | AVIANCA DESKUBRA Internacional | ||
| 71 | AVIATUR S.A. DAV NAL Nacional | ||
| 72 | AVIATUR S.A. DAV INT. Internacional | ||
| 74 | ASERCA AIRLINES Internacional | ||
| 78 | DELTA Internacional | ||
| 84 | TRANS AMERICAN Internacional | ||
| 86 | LUFTHANSA Internacional | ||
| 87 | LAN AIRLINES Nacional | ||
| 88 | LAN AIRLINES Internacional | ||
| 91 | ADA Nacional | ||
| 98 | AIR EUROPA Internacional | ||
| 99 | AGENCIAS DE VIAJES - T.A. Internacional | ||
| 100 | AEROMEXICO Internacional | ||
| 101 | CONVIASA Internacional | ||
| 103 | INSEL AIR Internacional | ||
| 104 | UNITED AIRLINES Internacional | ||
| 105 | JETBLUE AIRWAYS Internacional | ||
| 106 | TACA AIRLINES Internacional | ||
| 108 | KOREAN AIR LINES Internacional | ||
| 109 | TAME LINEA AEREA DEL ECUADOR Internacional | ||
| 110 | AIR PANAMA Suc.Col Internacional | ||
| 111 | AVIAREPS COLOMBIA Internacional | ||
| 112 | AVIA MARKETING LTDA NAL Nacional | ||
| 113 | AVIA MARKETING LTDA INT Internacional | ||
| 114 | ABC AEROLINEAS SA DE CV Internacional | ||
| 115 | KLM HOLANDESA DE AVIACION Internacional | ||
| 116 | OCEANAIR LINHAS AEREAS S.A Internacional | ||
| 117 | TURKISH AIRLINES | ||
| 119 | TAP PORTUGAL | ||
| 120 | ASIANA AIRLINES | ||
| 121 | ETHIOPIAN AIRLINES | ||
| 122 | EMIRATES | ||
| 123 | SINGAPORE AIRLINES | ||
| 124 | Viva Air Colombia | ||
| 125 | Viva Air Perú | ||
| 126 | SKY Airline Nacional | ||
| 127 | SKY Airline Internacional | ||
|
|
||
| ## Example of an airline dispersal request | ||
|
|
||
| ```json | ||
| { | ||
| ... | ||
| "payment": { | ||
| "reference": "ON1434012-PN1433129", | ||
| "description": "Vuelo 50 AV2020", | ||
| "amount": { | ||
| "taxes": [ | ||
| { | ||
| "kind": "airportTax", | ||
| "amount": 63 | ||
| }, | ||
| { | ||
| "kind": "valueAddedTax", | ||
| "amount": 158.47 | ||
| } | ||
| ], | ||
| "currency": "USD", | ||
| "total": 1161.12 | ||
| }, | ||
| "dispersion": [ | ||
| { | ||
| "agreement": 29, | ||
| "agreementType": "AIRLINE", | ||
| "amount": { | ||
| "taxes": [ | ||
| { | ||
| "kind": "airportTax", | ||
| "amount": 63 | ||
| }, | ||
| { | ||
| "kind": "valueAddedTax", | ||
| "amount": 142.5 | ||
| } | ||
| ], | ||
| "currency": "USD", | ||
| "total": 1055.5 | ||
| } | ||
| }, | ||
| { | ||
| "agreement": null, | ||
| "agreementType": "MERCHANT", | ||
| "amount": { | ||
| "taxes": [ | ||
| { | ||
| "kind": "valueAddedTax", | ||
| "amount": 15.97 | ||
| } | ||
| ], | ||
| "currency": "USD", | ||
| "total": 105.62 | ||
| } | ||
| } | ||
| ] | ||
| }, | ||
| "instrument": { | ||
| "card": { | ||
| "number": "5180300000000005", | ||
| "expiration": "12/24", | ||
| "cvv": "123" | ||
| } | ||
| } | ||
| ... | ||
| } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| export const apiRefs = ['/gateway/mpi/lookup', '/gateway/mpi/query'] | ||
|
|
||
| ## 3DS Lookup {{ id: 'mpi-lookup-request', tag: 'POST', label: '/gateway/mpi/lookup' }} | ||
|
|
||
| <Row> | ||
| <Col> | ||
| Performs the initial 3DS validation process, returning the data so that the user can continue with the process | ||
|
|
||
| <ApiReader | ||
| path="/gateway/mpi/lookup" | ||
| method="post" | ||
| api={props.refs} | ||
| /> | ||
| </Col> | ||
|
|
||
| <Col sticky> | ||
| <CodeGroup title="Solicitud" tag="POST" label="/gateway/mpi/lookup"> | ||
| ```bash {{ title: 'cURL' }} | ||
| curl -X "POST" https://api-co-dev.placetopay.ws/gateway/mpi/lookup \ | ||
| -H "Content-Type: application/json" \ | ||
| -d '{ | ||
| "locale": "es_CO", | ||
| "auth": { | ||
| "login":"c51ce410c124a10e0db5e4b97fc2af39", | ||
| "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", | ||
| "nonce":"NjE0OWVkODgwYjNhNw==", | ||
| "seed":"2021-09-21T09:34:48-05:00" | ||
| }, | ||
| "payment": { | ||
| "reference": "1122334455", | ||
| "description": "Testing Payment", | ||
| "amount": { | ||
| "currency": "USD", | ||
| "total": 100 | ||
| } | ||
| }, | ||
| "instrument": { | ||
| "card": { | ||
| "number": "4110760000000008", | ||
| "expiration": "12/20", | ||
| "cvv": "123" | ||
| } | ||
| }, | ||
| "returnUrl": "https://www.your-site.com/return?reference=1234567890" | ||
| }' | ||
| ``` | ||
| </CodeGroup> | ||
| </Col> | ||
| </Row> | ||
|
|
||
| --- | ||
|
|
||
| ## 3DS Query {{ id: 'mpi-query-request', tag: 'POST', label: '/gateway/mpi/query' }} | ||
|
|
||
| <Row> | ||
| <Col> | ||
| Once the user has completed the authentication process in 3DS, this endpoint is used to obtain the result of their operation | ||
|
|
||
| > ### Important Note | ||
| > | ||
| > *When consuming this service **NOT** the transaction is being authenticated by default, the value of `data` must be taken from the response and sent in the `instrument.threeDS`* | ||
|
|
||
| <ApiReader | ||
| path="/gateway/mpi/query" | ||
| method="post" | ||
| api={props.refs} | ||
| /> | ||
| </Col> | ||
|
|
||
| <Col sticky> | ||
| <CodeGroup title="Solicitud" tag="POST" label="/gateway/mpi/query"> | ||
| ```bash {{ title: 'cURL' }} | ||
| curl -X "POST" https://api-co-dev.placetopay.ws/gateway/mpi/query \ | ||
| -H "Content-Type: application/json" \ | ||
| -d '{ | ||
| "auth": { | ||
| "login":"c51ce410c124a10e0db5e4b97fc2af39", | ||
| "tranKey":"VQOcRcVH2DfL6Y4B4SaK6yhoH/VOUveZ3xT16OQnvxE=", | ||
| "nonce":"NjE0OWVkODgwYjNhNw==", | ||
| "seed":"2021-09-21T09:34:48-05:00" | ||
| }, | ||
| "instrument": { | ||
| "card": { | ||
| "number": "4110760000000008", | ||
| "expiration": "12/20", | ||
| "cvv": "123" | ||
| } | ||
| }, | ||
| "id": "1" | ||
| }' | ||
| ``` | ||
| </CodeGroup> | ||
| </Col> | ||
| </Row> |
Oops, something went wrong.