{"info":{"_postman_id":"da3bd9b6-c920-4373-a8c7-27ea0f693634","name":"OnRamp API reference","description":"The OnRamp API is organized around REST :
\n\nhas predictable resource-oriented URLs,
\naccepts raw JSON request bodies,
\nreturns JSON responses,
\nuses standard HTTP response codes, authentication, and verbs.
\n
\nYou can use the OnRamp API in sandbox mode, which does not affect your live data or interact with the banking networks.
\nFor each object, you'll find data examples to set out and clarify the requests and enable you to move quicker with the integration
\nFor each use case (recurring, 3ds, moto, etc..), you'll find a folder of request examples to ease your integration based on your own project.
\nOur documentation also includes, the list of our end-points to facilitate their use, test cards to use our API right away and a clear definition of our return codes.
\nWe use the snake_case style of writing for our API : all fields used in all the described endpoints will use this formatting.
\n
\nIntegration
\n\nYou have 2 ways of integrating our platform, either via hosted elements or directly using our API.
\n\nHosted elements : Card information here is handled by OnRamp, it only requires PCI compliance with SAQ A or A-EP.
\nDirect API : This integration type implies the ability to handle securely card information and according to PCI DSS rules, in compliance with a SAQ D.
\n
\n
\nTest cards
\n\nUse the following card numbers to proceed with your tests on the sandbox environment.
\nFor all the cards, you can use any expiry future date.
\nSuccessful transactions
\n\n
\nReturn codes
\n\nOnRamp uses conventional HTTP response codes to indicate the success or failure of an API request.
\nIn general:
\n\nCodes in the 2xx range indicate success.
\nCodes in the 4xx range indicate an error that failed due to the information provided (e.g., a required parameter is missing, an authorization failed, etc.).
\nCodes in the 5xx range indicate an error with OnRamp's servers
\n
\nTo complete the HTTP response codes, you will also receive a detailed return code that gives more indication on what has exactly happened with your request.
\nFor either a successful, pending or failed request, you will receive a code and its description.
\nThe code answers is based on 6 digits structured as follows :
\n\n- the first 4 digits give general information related to the kind of response and its origine
\n
\n\n\n\n | \n1st digit: order phase | \n2nd digit: origin | \n3rd digit: fallback | \n4th digit: side | \n
\n\n\n\n| 0 | \n | \n | \npossible | \nundetermined | \n
\n\n| 1 | \norder creation | \ntechnical | \nnot recommended | \nissuer side | \n
\n\n| 2 | \ntokenization | \nprocessing | \n | \nacquirer side | \n
\n\n| 3 | \nauthentication | \nrisk assessment | \n | \nACS | \n
\n\n| 4 | \nauthorization | \naccount related | \n | \nPSP | \n
\n\n| 5 | \ncapture | \nrouting issue | \n | \n | \n
\n\n| 6 | \nrefund | \nincomplete | \n | \n | \n
\n\n| 7 | \ncancel | \n | \n | \n | \n
\n\n| 9 | \nsuccess | \n | \n | \n | \n
\n\n
\n
\n- the last 2 digits give detailed information related to the reason code (please see list below).
\n
\n\nExample :
\n
\n\n\n\n| Code | \nDescription | \n
\n\n\n\n| 420230 | \nrisk rejection | \n
\n\n
\n
\nWe are in the authorization phase (1st digit = 4), it's a processing return code (2nd digit = 2), a fallback is possible (3rd digit = 0), the decision comes from the acquirer side (4th digit = 2), and it's a risk related decision (last 2 digits = 30)
\n
\nYou can find the whole detailed list below:
\n\n\n\n| Code | \nDescription | \n
\n\n\n\n| 100301 | \nsession creation unsuccessful | \n
\n\n| 111011 | \nmissing required parameter | \n
\n\n| 111012 | \ninvalid parameter | \n
\n\n| 111013 | \nan error occurred | \n
\n\n| 111022 | \ninvalid API key | \n
\n\n| 111023 | \nrequest forbidden due to limited credential rights - internal | \n
\n\n| 111034 | \nmax attempts reached | \n
\n\n| 111035 | \norder is already being processed | \n
\n\n| 131010 | \nblacklist | \n
\n\n| 131011 | \nblocked by PLACEHOLDER | \n
\n\n| 131020 | \nmismatch | \n
\n\n| 131030 | \nexternal check (AVS, missing 3D, device fingerprint, etc.) | \n
\n\n| 131040 | \ncountry not supported | \n
\n\n| 131050 | \nvelocity | \n
\n\n| 131051 | \ncard velocity | \n
\n\n| 131052 | \nemail velocity | \n
\n\n| 131053 | \nIP velocity | \n
\n\n| 131054 | \nverified info | \n
\n\n| 131055 | \nbin velocity | \n
\n\n| 131056 | \nbilling address velocity | \n
\n\n| 131057 | \nshipping address velocity | \n
\n\n| 131058 | \ncardholder name velocity | \n
\n\n| 131059 | \ncustom data velocity | \n
\n\n| 131088 | \nrisk blocked transaction | \n
\n\n| 133333 | \nrisk approved | \n
\n\n| 151021 | \ninvalid psp credentials | \n
\n\n| 151023 | \nrequest forbidden due to limited credential rights - external | \n
\n\n| 151040 | \nno route available for the requested payment method | \n
\n\n| 151041 | \nno route available for the requested currency | \n
\n\n| 151042 | \nno route available for the requested channel | \n
\n\n| 151043 | \nno route available for the requested partner | \n
\n\n| 161000 | \nclient dropped off | \n
\n\n| 221420 | \ntokenization failed | \n
\n\n| 240020 | \ninvalid account | \n
\n\n| 240021 | \ninvalid account - card number | \n
\n\n| 240022 | \ninvalid account - card expired | \n
\n\n| 241021 | \ntoken expired | \n
\n\n| 241031 | \ninvalid card information | \n
\n\n| 261000 | \nclient dropped off | \n
\n\n| 310070 | \nAuthentication declined | \n
\n\n| 320001 | \n3DS timeout | \n
\n\n| 320120 | \ncard not enrolled | \n
\n\n| 320310 | \nACS server unavailable | \n
\n\n| 341000 | \nincorrect authentication | \n
\n\n| 361000 | \nclient dropped off | \n
\n\n| 404000 | \nroute does not exist | \n
\n\n| 410070 | \nintegration error | \n
\n\n| 420030 | \nrisk rejection | \n
\n\n| 420040 | \nunsupported currency | \n
\n\n| 420041 | \nunsupported payment method | \n
\n\n| 420050 | \n3DS required | \n
\n\n| 420088 | \ndeclined | \n
\n\n| 420100 | \ninsufficient funds | \n
\n\n| 420110 | \nissuer server unavailable | \n
\n\n| 420111 | \nmax invalid attempts reached | \n
\n\n| 420130 | \nrisk rejection | \n
\n\n| 420150 | \nsoft decline - 3DS required | \n
\n\n| 420188 | \ndeclined by issuer | \n
\n\n| 420210 | \nacquirer server unavailable | \n
\n\n| 420230 | \nrisk rejection | \n
\n\n| 420240 | \ninvalid merchant ID configuration | \n
\n\n| 420241 | \nunsupported currency | \n
\n\n| 420242 | \nunsupported payment method | \n
\n\n| 420248 | \nerror in merchant configuration | \n
\n\n| 420250 | \n3DS required | \n
\n\n| 420260 | \ninvalid amount | \n
\n\n| 420288 | \ndeclined by acquirer | \n
\n\n| 420410 | \nPSP server unavailable | \n
\n\n| 421080 | \npending authorization | \n
\n\n| 421081 | \ndeclined | \n
\n\n| 421101 | \nthreshold limit | \n
\n\n| 421110 | \nissuer server unavailable | \n
\n\n| 421120 | \nunsupported currency | \n
\n\n| 421125 | \ncard expired | \n
\n\n| 421126 | \nrestricted card | \n
\n\n| 421127 | \noperation not allowed | \n
\n\n| 421130 | \nrisk rejection | \n
\n\n| 421131 | \nstolen card | \n
\n\n| 421132 | \nlost card | \n
\n\n| 440120 | \ninvalid card - updated card available | \n
\n\n| 441120 | \ninvalid card | \n
\n\n| 511030 | \nauthorization already captured | \n
\n\n| 511031 | \ncapture amount exceeding authorization | \n
\n\n| 511032 | \nduplicated capture request | \n
\n\n| 511033 | \ntoo many capture requests | \n
\n\n| 520120 | \nauthorization expired | \n
\n\n| 520220 | \ncapture unavailable | \n
\n\n| 521080 | \npending capture request | \n
\n\n| 521088 | \ncapture declined | \n
\n\n| 521100 | \norder cancelled by customer | \n
\n\n| 521188 | \ncapture declined | \n
\n\n| 521260 | \ninvalid amount | \n
\n\n| 521270 | \namount exceeding authorization | \n
\n\n| 521271 | \nauthorization already captured | \n
\n\n| 521272 | \nduplicated capture request | \n
\n\n| 521273 | \ntoo many capture requests | \n
\n\n| 521288 | \ncapture declined | \n
\n\n| 611030 | \nrefund amount exceeding captured amount | \n
\n\n| 611031 | \ncapture already refunded | \n
\n\n| 611032 | \nduplicated refund request | \n
\n\n| 611033 | \ntoo many refund requests | \n
\n\n| 620210 | \nrefund unavailable | \n
\n\n| 621080 | \npending refund request | \n
\n\n| 621088 | \nrefund declined | \n
\n\n| 621120 | \nrefund period expired | \n
\n\n| 621260 | \ninvalid amount | \n
\n\n| 621261 | \nrefund amount exceeding captured amount | \n
\n\n| 621270 | \ncapture already refunded | \n
\n\n| 621271 | \nduplicated refund request | \n
\n\n| 621272 | \ntoo many refund requests | \n
\n\n| 621288 | \nrefund declined | \n
\n\n| 711030 | \nauthorization expired | \n
\n\n| 711031 | \nauthorization already captured | \n
\n\n| 711032 | \nauthorization already cancelled | \n
\n\n| 711033 | \nduplicated cancel request | \n
\n\n| 720010 | \nauthorization cancellation unavailable | \n
\n\n| 721080 | \npending cancel request | \n
\n\n| 721088 | \nauthorization cancellation declined | \n
\n\n| 721170 | \nauthorization expired | \n
\n\n| 721171 | \nauthorization already captured | \n
\n\n| 721172 | \nauthorization already cancelled | \n
\n\n| 721188 | \nauthorization cancellation declined | \n
\n\n| 721288 | \nauthorization cancellation declined | \n
\n\n| 900000 | \nsession created successfully | \n
\n\n| 922222 | \ntokenization successful | \n
\n\n| 944444 | \nauthorization successful | \n
\n\n| 955555 | \ncapture successful | \n
\n\n| 966666 | \nrefund successful | \n
\n\n| 977777 | \ncancel successful | \n
\n\n| 988888 | \nsettlement successful | \n
\n\n
\n
Here is an exemple of the object you will receive in response.
\n{\n \"result\": {\n \"code\": \"944444\",\n \"description\": \"Authorization successful\"\n }\n}\n\n
\nNotifications
\n\nYou can create a webhook directly in the setting menu of your OnRamp account that will subscribe to a list of events on the order.
\nWe strongly recommend to at least subscribe to the authorization_successful event to confirm the order on your own webshop.
\nHere is a sample of a notification :
\n{\n\"request_id\":\"3456789876545678456789765\",\n\"order_id\": \"60509208505368000a3dfbd2\",\n\"transaction_id\":\"68HGVFT5RTGVU\",\n\"merchant_order_id\": \"9J3947DB29D\",\n\"merchant_contract_id\":\"489YGF68YGT545678YG\",\n\"status\": \"authorization_successful\",\n\"action_date\":\"2023-08-12T12:45:48+0000\",\n\"amount\":118.98,\n\"payin_partner\":\"checkout\",\n\"payin_transaction_id\":\"pay_5689IHVFR43456789UYHGVGYU876545678UYG\",\n\"payin_transaction_description\":\"APPROVED\",\n\"authentication_partner\":\"checkout\",\n\"authentication_result\":\"success\",\n\"risk_assessment_partner\":\"checkout\",\n\"risk_assessment_result\":\"accepted\",\n\"payment_method\":\"VISA\",\n\"capture_total_amount\":0.00,\n\"refund_total_amount\":0.00,\n\"currency\":\"EUR\",\n\"is_capturable\":true,\n\"is_refundable\":false,\n\"is_cancellable\":true,\n\"link_interface\":\"\",\n\"card_6_digits\": \"424242\",\n\"card_4_digits\": \"4242\",\n\"card_validity_month\": \"02\",\n\"card_validity_year\": \"25\",\n\"card_issuer\": \"\",\n\"card_country\": \"GB\",\n\"merchant_account\": \"615f3066c67357000ad556e1\",\n\"token\": \"072bd9c0b63dde38e2d41e906273d1b59acfe6dea2c3d9a877c8ed7806c2b5eb\",\n\"is_order_last_transaction\": true\n}\n\n
\nThe headers will contain the norbr-signature parameter and the norbr-timestamp.
\nTo verify the notification, you need to :
\n\nTransform the json body into string .
\nConcatenate : string-body+norbr-timestamp
\nHash the string using HMAC-SHA256 and Secret Key (coding = UTF8)
\nCheck that the encoded hash in base16 = norbr-signature
\n
\nExample
\n\n\n\n\n\n| parameters | \nvalue | \n
\n\n\n\n| norbr-timestamp | \n1639569054 | \n
\n\n| norbr-signature | \n5a938268e15a97a17f465a540ba0b7c05899b342b61e67aa1b3b1ba74d2f61a9 | \n
\n\n
\n
If the body of the notification is :
\n {\"request_id\":\"3456789876545678456789765\",\"order_id\":\"60509208505368000a3dfbd2\",\"transaction_id\":\"68HGVFT5RTGVU\",\"merchant_order_id\":\"9J3947DB29D\",\"merchant_contract_id\":\"489YGF68YGT545678YG\",\"status\":\"authorization_successful\",\"action_date\":\"2023-08-12T12:45:48+0000\",\"amount\":118.98,\"payin_partner\":\"checkout\",\"payin_transaction_id\":\"pay_5689IHVFR43456789UYHGVGYU876545678UYG\",\"payin_transaction_description\":\"APPROVED\",\"authentication_partner\":\"checkout\",\"authentication_result\":\"success\",\"risk_assessment_partner\":\"checkout\",\"risk_assessment_result\":\"accepted\",\"payment_method\":\"VISA\",\"capture_total_amount\":0,\"refund_total_amount\":0,\"currency\":\"EUR\",\"is_capturable\":true,\"is_refundable\":false,\"is_cancellable\":true,\"link_interface\":\"\",\"card_6_digits\":\"424242\",\"card_4_digits\":\"4242\",\"card_validity_month\":\"02\",\"card_validity_year\":\"25\",\"card_issuer\":\"\",\"card_country\":\"GB\",\"merchant_account\":\"615f3066c67357000ad556e1\",\"token\":\"072bd9c0b63dde38e2d41e906273d1b59acfe6dea2c3d9a877c8ed7806c2b5eb\",\"is_order_last_transaction\":true}\n\n
\n\n- Transform the json body into string :
\n
\n\n{\"request_id\":\"3456789876545678456789765\",\"order_id\":\"60509208505368000a3dfbd2\",\"transaction_id\":\"68HGVFT5RTGVU\",\"merchant_order_id\":\"9J3947DB29D\",\"merchant_contract_id\":\"489YGF68YGT545678YG\",\"status\":\"authorization_successful\",\"action_date\":\"2023-08-12T12:45:48+0000\",\"amount\":118.98,\"payin_partner\":\"checkout\",\"payin_transaction_id\":\"pay_5689IHVFR43456789UYHGVGYU876545678UYG\",\"payin_transaction_description\":\"APPROVED\",\"authentication_partner\":\"checkout\",\"authentication_result\":\"success\",\"risk_assessment_partner\":\"checkout\",\"risk_assessment_result\":\"accepted\",\"payment_method\":\"VISA\",\"capture_total_amount\":0,\"refund_total_amount\":0,\"currency\":\"EUR\",\"is_capturable\":true,\"is_refundable\":false,\"is_cancellable\":true,\"link_interface\":\"\",\"card_6_digits\":\"424242\",\"card_4_digits\":\"4242\",\"card_validity_month\":\"02\",\"card_validity_year\":\"25\",\"card_issuer\":\"\",\"card_country\":\"GB\",\"merchant_account\":\"615f3066c67357000ad556e1\",\"token\":\"072bd9c0b63dde38e2d41e906273d1b59acfe6dea2c3d9a877c8ed7806c2b5eb\",\"is_order_last_transaction\":true}
\n
\n\n- Concatenate
string-body+norbr-timestamp \n
\n\n{\"request_id\":\"3456789876545678456789765\",\"order_id\":\"60509208505368000a3dfbd2\",\"transaction_id\":\"68HGVFT5RTGVU\",\"merchant_order_id\":\"9J3947DB29D\",\"merchant_contract_id\":\"489YGF68YGT545678YG\",\"status\":\"authorization_successful\",\"action_date\":\"2023-08-12T12:45:48+0000\",\"amount\":118.98,\"payin_partner\":\"checkout\",\"payin_transaction_id\":\"pay_5689IHVFR43456789UYHGVGYU876545678UYG\",\"payin_transaction_description\":\"APPROVED\",\"authentication_partner\":\"checkout\",\"authentication_result\":\"success\",\"risk_assessment_partner\":\"checkout\",\"risk_assessment_result\":\"accepted\",\"payment_method\":\"VISA\",\"capture_total_amount\":0,\"refund_total_amount\":0,\"currency\":\"EUR\",\"is_capturable\":true,\"is_refundable\":false,\"is_cancellable\":true,\"link_interface\":\"\",\"card_6_digits\":\"424242\",\"card_4_digits\":\"4242\",\"card_validity_month\":\"02\",\"card_validity_year\":\"25\",\"card_issuer\":\"\",\"card_country\":\"GB\",\"merchant_account\":\"615f3066c67357000ad556e1\",\"token\":\"072bd9c0b63dde38e2d41e906273d1b59acfe6dea2c3d9a877c8ed7806c2b5eb\",\"is_order_last_transaction\":true}1639569054
\n
\n\n- Hash the previous string using HMAC-SHA256 with SecretKey
\n
\nIf secret-key=3456789876543235TGY8 then hash is :
\n\n5a938268e15a97a17f465a540ba0b7c05899b342b61e67aa1b3b1ba74d2f61a9
\n
\n\n- Check that
norbr-signature value equals the encoded hash in the last step \n
\n
\nHosted Elements
\n\nOnRamp hosted fields is an easy way to customize your checkout flow without having to deal with the hassle of PCI Compliance (you will only need to comply with SAQ A questionnaire). The sensitive information will be collected through these elements and sent out to OnRamp without ever communicating with your own server, thanks to a script intercepting the sensitive information before submitting the form. You’ll just have to focus on customizing your checkout experience.
\nThe OnRamp hosted fields include several helpful features such as:
\n\ndisplaying the card logo once the first number of the card is entered
\ndisplaying 2 selectable logos in the case of co-branded cards (MIF compliant)
\nformatting the card information as it is filled in
\ncustomizing the look and feel of the payment page to seamlessly integrate it within your checkout flow
\nhandling errors to help your customer fill out the form
\nusing responsive fields that fit with your customers’ mobile device
\n
\nHow to start using OnRamp's hosted fields ?
\n\nFirst you have to set-up the OnRamp hosted fields library within your HTML page.
\nA simple way to do it consists in adding the script tag to the head of your HTML file and the stylesheet, like in the following example :
\n<script src=\"https://secure-assets-sandbox.norbr.io/javascript/x.x/norbr-client.min.js\"></script>\n<link rel=\"stylesheet\" href=\"https://secure-assets-sandbox.norbr.io/stylesheet/x.x/norbr-client.min.css\">\n\n
\nPlease contact support@norbr.help so we provide the last version (x.x) to use.
\nThen you add a div for the container to display the fields.
The id of the div must be: norbr-payment-container
\nThen you must create a JS instance of the OnRamp component, by sending several parameters ,like in the following example:
\n\n\n\n| Parameters | \nformat | \nDescription | \n
\n\n\n\n| publicapikey | \nNR_PUB_XXXXXX | \nYour public api key available on your merchant portal and has restricted privileges for a client use. | \n
\n\n| locale | \nalpha-2 | \nLanguage used to display the fields | \n
\n\n| environment | \nenum | \nsandbox or production | \n
\n\n| tokentype | \nenum | \noneshot or recurring. refers to reusability of the token | \n
\n\n| checkoutId | \nstring | \nid of the checkout created previously | \n
\n\n| displayButtons | \nboolean | \nDisplay or not the pay button | \n
\n\n| displayCardHolder | \nboolean | \nDisplay or not the cardholder name field | \n
\n\n| displaySave | \nboolean | \nDisplay or not the card save button | \n
\n\n| CardHolderValue | \nstring | \nDynamic field to display the name already filled out by your customer during his payment journey. | \n
\n\n
\n
const configuration = {\n publicapikey:\"\",\n locale:\"en\",\n environment:\"sandbox\",\n tokentype:\"oneshot\",\n checkoutId: '67ceac5ab0680aa29acb52e2',\n displayButtons: true,\n displayCardHolder: true,\n displaySave: true,\n CardHolderValue: \"mr smith\",\n onSubmit: () => {\n ((place here the method to handle the data returned by the hosted fields)) \n }\n };\n var norbr = new Norbr(configuration);\n\n
\nWhen the customer clicks on the button to validate the form, OnRamp catches the form content and creates a token.
\nYou will then have to use this token to create the order once the customer clicks on the pay button.
\nFinally you can customize the look and feel of the fields by using CSS.
\nHere is a diagram of the possible flow for a Hosted Elements integration :
\n![](\"https://content.pstmn.io/cf47246f-0975-481a-93d0-83476fa52fe2/RmxvdyBpbnRlZ3JhdGlvbiBob3N0ZWQgZmllbGRzLmpwZw==\")
\n\n
\nDirect API
\n\nAuthentication
\n\nThe OnRamp API uses API keys to authenticate requests. You can view and manage your API keys in your OnRamp account.
\nYour API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
\nProvide your API key in the header of your call via the x-api-key field in the header. You do not need to provide a password.
\nAll API requests must be made over HTTPS, calls made over plain HTTP will fail. API requests without authentication will also fail.
\n
\nEndpoints
\n\n\n\n\n| Sandbox | \nProduction | \n
\n\n\n\n| api-sandbox.onramppay.com/payment/checkout | \napi.onramppay.com/payment/checkout | \n
\n\n| api-sandbox.onramppay.com/payment/order | \napi.onramppay.com/payment/order | \n
\n\n| api-sandbox.onramppay.com/payment/maintenance | \napi.onramppay.com/payment/maintenance | \n
\n\n
\n
Post /payment/checkout
\nUsed to create a checkout
\nPost /payment/order
\nUsed to create an order
\nPost /payment/maintenance
\nUsed to capture or refund an order and void an authorization
\n
\nVersionning
\n\nAll API requests require to send the version of the API used. The current version of our API is 1.0.0.
\nThe version of the API needs to be sent in the header of all requests.
\n
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Integration","slug":"integration"},{"content":"Test cards","slug":"test-cards"},{"content":"Return codes","slug":"return-codes"},{"content":"Notifications","slug":"notifications"},{"content":"Hosted Elements","slug":"hosted-elements"},{"content":"Direct API","slug":"direct-api"}],"owner":"15029336","collectionId":"da3bd9b6-c920-4373-a8c7-27ea0f693634","publishedId":"2sB2xCiVRa","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-06-24T14:12:41.000Z"},"item":[{"name":"Checkout","item":[{"name":"Create checkout","id":"655b176e-ec23-4221-9942-56536a88c33b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"Private api key","description":"Private api key
\n","type":"text"},{"key":"version","value":"1.0.0","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"accept_url","value":" max 255","description":"URL to redirect your customer to once the payment process is completed successfully.
\n","type":"text"},{"key":"amount","value":"","description":"A positive number with 3 decimals digit max to describe the charge of the order
\n","type":"text"},{"key":"authentication_indicator","value":"","description":"Selects the authentication scenario you want applied for this order : no_3ds, ask_3ds, force_3ds
\n","type":"text"},{"key":"basket_content","value":"","description":"Details of the basket item by item, please refer to the example to see all the fields available in the array. We strongly recommend that you either use this field or the 3 following ones : 'order_description,order_availability and order_availability_date. But not all at the same time.
\n","type":"text"},{"key":"basket_id","value":"","description":"Unique identifier of the basket.
\n","type":"text"},{"key":"basket_type","value":"","description":"Indicates the type of items in the basket : physical, digital or mixed
\n","type":"text"},{"key":"cancel_url","value":" max 255","description":"URL to redirect your customer to if the payment is cancelled (for hosted page only)
\n","type":"text"},{"key":"challenge_preference","value":"","description":"Selects the authentication scenario you want applied for this order : no_preference,challenge_mandatory,challenge_requested,no_challenge
\n","type":"text"},{"key":"contract_id","value":"","description":"The unique id of the contract between you and your customer.
\n","type":"text"},{"key":"currency","value":"","description":"The 3-letter ISO currency code refering to the authorization currency
\n","type":"text"},{"key":"customer_account_add_payment_means_date","value":"","description":"The date of the payment method 's registration on the customer's account.
\n","type":"text"},{"key":"customer_account_attempts_order_day","value":"","description":"The number of order (succesfull or failed) registered for this customer in the last 24 hours
\n","type":"text"},{"key":"customer_account_attempts_order_six_months","value":"","description":"The number of order (succesfull or failed) registered for this customer in the last 6 months
\n","type":"text"},{"key":"customer_account_attempts_order_year","value":"","description":"The number of order (succesfull or failed) registered for this customer in the last year
\n","type":"text"},{"key":"customer_account_change_date","value":"","description":"The date of the last update of the customer's account.
\n","type":"text"},{"key":"customer_account_change_password_date","value":"","description":"The date of the last password change on the customer's account.
\n","type":"text"},{"key":"customer_account_creation_date","value":"","description":"The creation date of the customer's account.
\n","type":"text"},{"key":"customer_account_successful_orders_day","value":"","description":"The number of successful order registered for this customer in the last 24 hours
\n","type":"text"},{"key":"customer_account_successful_orders_six_months","value":"","description":"The number of successful order registered for this customer in the last 6 months
\n","type":"text"},{"key":"customer_account_successful_orders_year","value":"","description":"The number of successful order registered for this customer in the last year.
\n","type":"text"},{"key":"customer_billing_city","value":"","description":"The billing customer city.
\n","type":"text"},{"key":"customer_billing_country","value":"","description":"The billing customer country. 2-letter ISO country code
\n","type":"text"},{"key":"customer_billing_first_name","value":"","description":"The billing customer first name.
\n","type":"text"},{"key":"customer_billing_last_name","value":"","description":"The billing customer last name.
\n","type":"text"},{"key":"customer_billing_street_name","value":"","description":"The billing customer address.
\n","type":"text"},{"key":"customer_billing_zip_code","value":"","description":"The billing customer zip code.
\n","type":"text"},{"key":"customer_birth_date","value":"","description":"The customer birth date.
\n","type":"text"},{"key":"customer_browser_info_accept_header","value":"","description":"The accept header value of the customer's browser.
\n","type":"text"},{"key":"customer_browser_info_color_depth","value":"","description":"The color depth of the customer's browser in bits per pixel.
\n","type":"text"},{"key":"customer_browser_info_java_enabled","value":"","description":"Indicates if the customer's browser is able to execute java.
\n","type":"text"},{"key":"customer_browser_info_js_enabled","value":"","description":"Indicates if the customer's browser is able to execute javascript
\n","type":"text"},{"key":"customer_browser_info_language","value":"","description":"The language of the customer's browser.
\n","type":"text"},{"key":"customer_browser_info_screen_height","value":"","description":"The height of the customer's browser.
\n","type":"text"},{"key":"customer_browser_info_screen_width","value":"","description":"The width of the customer's browser.
\n","type":"text"},{"key":"customer_browser_info_time_zone","value":"","description":"The time zone of the customer's browser. It could be in the one of the following format:\n\"±hh:mm\", \"±hhmm\", or \"±hh\"
\n","type":"text"},{"key":"customer_browser_info_user_agent","value":"","description":"The user agent of the customer's browser.
\n","type":"text"},{"key":"customer_city","value":"","description":"The customer's city.
\n","type":"text"},{"key":"customer_country","value":"","description":"The customer's country. 2-letter ISO country code
\n","type":"text"},{"key":"customer_email","value":"","description":"The customer's e-mail address.
\n","type":"text"},{"key":"customer_first_name","value":" max 255","description":"The customer's first name.
\n","type":"text"},{"key":"customer_gender","value":"","description":"The customer's gender : male, female, other
\n","type":"text"},{"key":"customer_id","value":"","description":"The unique identifier of the customer.
\n","type":"text"},{"key":"customer_identification_number","value":" max 255","description":"The customer's identification number. Depending on the payment method, this field can be used to send an ID number or a fiscal number.
\n","type":"text"},{"key":"customer_ip","value":" 2 to 26","description":"The customer's ip address.
\n","type":"text"},{"key":"customer_items_reorder","value":"","description":"Indicates if the customer has already ordered one of the items in the basket during the past year.
\n","type":"text"},{"key":"customer_last_name","value":"","description":"The customer's last name.
\n","type":"text"},{"key":"customer_os_version","value":"","description":"Version of the mobile os of the customer
\n","type":"text"},{"key":"customer_phone_number","value":" 7 to 50","description":"The customer phone number.
\n","type":"text"},{"key":"customer_phone_number_type","value":"","description":"The customer type of phone number : mobile, home, work
\n","type":"text"},{"key":"customer_street_name","value":"","description":"The customer's address.
\n","type":"text"},{"key":"customer_zip_code","value":"","description":"The customer's zip code.
\n","type":"text"},{"key":"decline_url","value":" max 255","description":"URL to redirect your customer to after the payment is declined.
\n","type":"text"},{"key":"device_type","value":"","description":"The type of device used by the customer for this order: mobile, laptop, desktop
\n","type":"text"},{"key":"exception_url","value":" max 255","description":"URL to redirect your customer to after a system failure.
\n","type":"text"},{"key":"expiration_date","value":"","description":"The checkout expiration date. A date in ISO format. The expiration will be 15mn by default if not provided.
\n","type":"text"},{"key":"hosted_fields_version","value":"","description":"Version of the hosted fields or hosted elements used
\n","type":"text"},{"key":"is_customer_registered","value":"","description":"Indicates if the customer has an account.
\n","type":"text"},{"key":"is_return_accepted","value":"","description":"Indicates if returns are accepted for this order.
\n","type":"text"},{"key":"locale","value":"","description":"The 2-letter alpha ISO country code (ex: en, fr, it) followed by the 2-letter ISO language code (ex: en_GB, fr_FR, it_IT)
\n","type":"text"},{"key":"max_attempts","value":"","description":"Maximum number of attempts possible on this order. Includes update and fallbacks
\n","type":"text"},{"key":"operation_type","value":"","description":"Specify the kind of order you want to create: authorize or direct_capture
\n","type":"text"},{"key":"order_availability","value":"","description":"Availability of the order at the moment of the order.
\n","type":"text"},{"key":"order_availability_date","value":"","description":"Estimated date of availability of the order if not available at the moment of the order.
\n","type":"text"},{"key":"order_description","value":" max 255","description":"General description of the order.
\n","type":"text"},{"key":"order_merchant_id","value":" max 255","description":"(Required) Unique identifier used by the merchant for an order
\n","type":"text"},{"key":"order_tax_amount","value":"","description":"Total amount of tax for the order
\n","type":"text"},{"key":"payment_channel","value":"","description":"Describes where the transaction is taking place. Possible values : e-commerce, moto, pos
\n","type":"text"},{"key":"payment_method_name","value":"","description":"The name of the method used by the customer to pay this order. Please refer to the APM folder
\n","type":"text"},{"key":"payment_method_type","value":"","type":"text"},{"key":"pending_url","value":"","description":"URL to redirect your customer to when the payment request was processed but response is not yet available
\n","type":"text"},{"key":"plan_id","value":"","description":"The unique id of the plan subscribed by the customer.
\n","type":"text"},{"key":"sca_exemption_reason","value":"","description":"Indicates the reason why the order should be exempted from 3DSecure : low_value, corporate, trusted_beneficiary, risk_analysis
\n","type":"text"},{"key":"shipping_address_city","value":" max 255","description":"The shipping address city.
\n","type":"text"},{"key":"shipping_address_country","value":" max 255","description":"The shipping address country. 2-letter ISO country code
\n","type":"text"},{"key":"shipping_address_first_use_date","value":"","description":"The date when the shipping address was first used.
\n","type":"text"},{"key":"shipping_address_state","value":"","description":"The shipping address state
\n","type":"text"},{"key":"shipping_address_street_name_line1","value":" max 255","description":"The shipping address street name (first line)
\n","type":"text"},{"key":"shipping_address_street_name_line2","value":" max 255","description":"The shipping address street name (second line)
\n","type":"text"},{"key":"shipping_address_zip_code","value":" max 255","description":"The shipping address zip code.
\n","type":"text"},{"key":"shipping_carrier_name","value":" max 255","description":"Name of the carrier used for the shipping
\n","type":"text"},{"key":"shipping_delivery_method","value":"","description":"Indicates where the order is being delivered : customer_address, in_store, pickup_store, other
\n","type":"text"},{"key":"shipping_delivery_range","value":"","description":"Estimated range of delivery. Possible values : sameday, lessthan2days, morethan2days
\n","type":"text"},{"key":"shipping_email","value":" max 25","description":"Email for the shipping
\n","type":"text"},{"key":"shipping_first_name","value":" max 255","description":"The shipping address first name.
\n","type":"text"},{"key":"shipping_id","value":" max 255","description":"Unique identifier of the shipping.
\n","type":"text"},{"key":"shipping_last_name","value":" max 255","description":"The shipping address last name.
\n","type":"text"},{"key":"shipping_phone_number","value":" 7 to 25","description":"The shipping address phone number
\n","type":"text"},{"key":"shipping_price","value":"","description":"Total price of the delivery.
\n","type":"text"},{"key":"shipping_tax","value":"","description":"Amount of tax included in the total shipping amount.
\n","type":"text"},{"key":"shipping_tax_rate","value":"","description":"Tax rate applied on the shipping.
\n","type":"text"},{"key":"subscriber_id","value":"","description":"The unique id of the suscriber.
\n","type":"text"},{"key":"subscription_count","value":"","description":"The rank in the installments plan.
\n","type":"text"},{"key":"subscription_description","value":" max 255","description":"The description of the subscription.
\n","type":"text"},{"key":"subscription_end_date","value":"","description":"The date of the end of the subscription
\n","type":"text"},{"key":"subscription_recurrence","value":"","description":"The occurence of the subscription :weekly, fifteen_days, month, two_months, three_months, yearly, other
\n","type":"text"},{"key":"sdk_version","value":"","description":"Version of the sdk used. android_version_number, ios_version_number
\n","type":"text"},{"key":"token_type","value":"","description":"The type of token that will be used: \"oneshot\",\"recurring\"
\n","type":"text"},{"key":"type","value":"","description":"(Required) The type of checkout: “hosted_fields”, “hosted_page”,”api,”mobile_sdk”,”qrcode”,”mail_to_pay”
\n","type":"text"},{"key":"website_url","value":"","description":"The website where the order was issued.
\n","type":"text"}]},"url":"{{apiUrl}}/payment/checkout","description":"The /payment/checkout request can be used for different use cases and accept numerous information about your customer or the order itself.
\nBelow, we list all the fields that are accepted in the /payment/checkout request, to give you the maximum overview of our endpoint.
\nYou don't have to use them all, feel free to refer to the specific use case requests described in the documentation.
\n","urlObject":{"path":["payment","checkout"],"host":["{{apiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"fd3f27de-5835-4dfa-bc71-71ce1707e1ae","name":"Create checkout for type API","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"YOUR_PRIVATE_API_KEY","type":"text"},{"key":"version","value":"1.0.0","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"api\",\n \"locale\": \"fr_FR\",\n \"payment_method_name\": \"visa\",\n \"operation_type\":\"authorize\",\n \"amount\": 68.18,\n \"currency\": \"EUR\",\n \"order_merchant_id\": \"276398531664\",\n \"payment_channel\": \"e-commerce\",\n \"website_url\": \"https://www.example.com/\",\n \"device_type\": \"mobile\",\n \"customer_id\": \"4025251046660958\",\n \"customer_email\": \"kirby.nash@gmail.com\",\n \"customer_first_name\": \"Kirby\",\n \"customer_last_name\": \"Nash\",\n \"customer_identification_number\": \"GTF730340H7\",\n \"customer_gender\": \"female\",\n \"customer_street_name\": \"37 rue du Président Roosevelt\",\n \"customer_city\": \"SARTROUVILLE\",\n \"customer_zip_code\": \"78500\",\n \"customer_country\": \"FR\",\n \"customer_ip\": \"203.200.6.117\",\n \"customer_billing_first_name\": \"Kirby\",\n \"customer_billing_last_name\": \"Nash\",\n \"customer_billing_street_name\": \"37 rue du Président Roosevelt\",\n \"customer_billing_city\": \"SARTROUVILLE\",\n \"customer_billing_zip_code\": \"78500\",\n \"customer_billing_country\": \"FR\",\n \"customer_birth_date\": \"2020-06-22\",\n \"customer_phone_number\": \"0686606737\",\n \"customer_phone_number_type\": \"mobile\",\n \"is_customer_registered\": true,\n \"customer_account_creation_date\": \"2020-03-19\",\n \"customer_account_change_date\": \"2020-06-18\",\n \"customer_account_change_password_date\": \"2020-06-18\",\n \"customer_account_attempts_order_day\": \"1\",\n \"customer_account_attempts_order_six_months\": \"6\",\n \"customer_account_attempts_order_year\": \"8\",\n \"customer_account_successful_orders_day\": \"1\",\n \"customer_account_successful_orders_six_months\": \"5\",\n \"customer_account_successful_orders_year\": \"7\",\n \"customer_account_add_payment_means_date\": \"2020-06-18\",\n \"customer_browser_info_color_depth\": \"test1\",\n \"customer_browser_info_accept_header\": \"test2\",\n \"customer_browser_info_java_enabled\": true,\n \"customer_browser_info_js_enabled\": false,\n \"customer_browser_info_language\": \"FR\",\n \"customer_browser_info_screen_height\": 119,\n \"customer_browser_info_screen_width\": 333,\n \"customer_browser_info_time_zone\": \"+01:00\",\n \"customer_browser_info_user_agent\": \"Mozilla---\",\n \"is_return_accepted\": true,\n \"basket_id\": \"BSK-5942478750\",\n \"basket_type\": \"physical\",\n \"basket_content\": [\n {\n \"product_sku\": \"TSH-MED-WHI-COT\",\n \"product_id\": \"39851062\",\n \"product_name\": \"Tee Shirt MED\",\n \"product_description\": \"White tee shirt, size M\",\n \"product_price\": \"20.00\",\n \"product_quantity\": \"2\",\n \"product_availability\": true,\n \"product_type\": \"physical\",\n \"product_tax_amount\": \"4.14\",\n \"total_amount\": \"44.14\",\n \"seller_id\": \"SEL-07428099\",\n \"seller_name\": \"nounplus\",\n \"seller_commission\": \"4.41\"\n },\n {\n \"product_sku\": \"DRE-MED-RED-LEA\",\n \"product_id\": \"40547343\",\n \"product_name\": \"Dress MED\",\n \"product_description\": \"Red dress, size M\",\n \"product_price\": \"22\",\n \"product_quantity\": \"1\",\n \"product_availability\": true,\n \"product_type\": \"physical\",\n \"product_tax_amount\": \"2.04\",\n \"total_amount\": \"24.04\",\n \"seller_id\": \"SEL-54539757\",\n \"seller_name\": \"faruber\",\n \"seller_commission\": \"2.4\"\n }\n ],\n \"shipping_id\": \"318378289489\",\n \"shipping_carrier_name\": \"DHL\",\n \"shipping_delivery_range\": \"sameday\",\n \"shipping_delivery_method\": \"customer_address\",\n \"shipping_price\": 20,\n \"shipping_tax\": 5,\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_phone_number\": \"\",\n \"shipping_address_street_name_line1\": \"16 rue de Raymond Poincaré\",\n \"shipping_address_street_name_line2\": null,\n \"shipping_address_city\": \"NEUILLY-SUR-SEINEs\",\n \"shipping_address_zip_code\": \"92200\",\n \"shipping_address_country\": \"FR\",\n \"shipping_address_first_use_date\": \"2020-03-19\",\n \"plan_id\": \"PL-532332\",\n \"contract_id\": \"CT-532332\",\n \"subscriber_id\": \"SBE-532332\",\n \"subscription_description\": \"3 months waranty\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.onramppay.com/payment/checkout"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"environment","value":"sandbox","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"code\": \"011111\",\n \"description\": \"checkout created successfully\"\n },\n \"checkout\": {\n \"accept_url\": \"https://www.test.com\",\n \"amount\": 68.18,\n \"basket_content\": [\n {\n \"product_availability\": true,\n \"product_description\": \"White tee shirt, size M\",\n \"product_id\": \"39851062\",\n \"product_name\": \"Tee Shirt MED\",\n \"product_price\": 20,\n \"product_quantity\": 2,\n \"product_sku\": \"TSH-MED-WHI-COT\",\n \"product_tax_amount\": 4.14,\n \"product_type\": \"physical\",\n \"seller_commission\": 4.41,\n \"seller_id\": \"SEL-07428099\",\n \"seller_name\": \"nounplus\",\n \"total_amount\": 44.14\n },\n {\n \"product_availability\": true,\n \"product_description\": \"Red dress, size M\",\n \"product_id\": \"40547343\",\n \"product_name\": \"Dress MED\",\n \"product_price\": 22,\n \"product_quantity\": 1,\n \"product_sku\": \"DRE-MED-RED-LEA\",\n \"product_tax_amount\": 2.04,\n \"product_type\": \"physical\",\n \"seller_commission\": 2.4,\n \"seller_id\": \"SEL-54539757\",\n \"seller_name\": \"faruber\",\n \"total_amount\": 24.04\n }\n ],\n \"basket_id\": \"BSK-5942478750\",\n \"basket_type\": \"physical\",\n \"contract_id\": \"CT-532332\",\n \"currency\": \"EUR\",\n \"customer_account_add_payment_means_date\": \"2020-06-18T00:00:00.000Z\",\n \"customer_account_attempts_order_day\": 1,\n \"customer_account_attempts_order_six_months\": 6,\n \"customer_account_attempts_order_year\": 8,\n \"customer_account_change_date\": \"2020-06-18T00:00:00.000Z\",\n \"customer_account_change_password_date\": \"2020-06-18T00:00:00.000Z\",\n \"customer_account_creation_date\": \"2020-03-19T00:00:00.000Z\",\n \"customer_account_successful_orders_day\": 1,\n \"customer_account_successful_orders_six_months\": 5,\n \"customer_account_successful_orders_year\": 7,\n \"customer_billing_city\": \"SARTROUVILLE\",\n \"customer_billing_country\": \"FR\",\n \"customer_billing_first_name\": \"Kirby\",\n \"customer_billing_last_name\": \"Nash\",\n \"customer_billing_street_name\": \"37 rue du Président Roosevelt\",\n \"customer_billing_zip_code\": \"78500\",\n \"customer_birth_date\": \"2020-06-22T00:00:00.000Z\",\n \"customer_browser_info_accept_header\": \"test2\",\n \"customer_browser_info_color_depth\": \"test1\",\n \"customer_browser_info_java_enabled\": true,\n \"customer_browser_info_js_enabled\": false,\n \"customer_browser_info_language\": \"FR\",\n \"customer_browser_info_screen_height\": 119,\n \"customer_browser_info_screen_width\": 333,\n \"customer_browser_info_time_zone\": \"Paris/London\",\n \"customer_browser_info_user_agent\": \"Mozilla---\",\n \"customer_city\": \"SARTROUVILLE\",\n \"customer_country\": \"FR\",\n \"customer_email\": \"kirby.nash@gmail.com\",\n \"customer_first_name\": \"Kirby\",\n \"customer_gender\": \"female\",\n \"customer_id\": \"4025251046660958\",\n \"customer_identification_number\": \"GTF730340H7\",\n \"customer_ip\": \"203.200.6.117\",\n \"customer_last_name\": \"Nash\",\n \"customer_phone_number\": \"0686606737\",\n \"customer_phone_number_type\": \"mobile\",\n \"customer_street_name\": \"37 rue du Président Roosevelt\",\n \"customer_zip_code\": \"78500\",\n \"decline_url\": \"https://www.test.com\",\n \"device_type\": \"mobile\",\n \"exception_url\": \"https://www.test.com\",\n \"expiration_date\": \"2023-10-18T15:08:21.133Z\",\n \"is_customer_registered\": true,\n \"is_return_accepted\": true,\n \"locale\": \"fr-FR\",\n \"operation_type\": \"authorize\",\n \"order_merchant_id\": \"276398531664\",\n \"token_type\": \"oneshot\",\n \"type\": \"api\",\n \"payment_channel\": \"e-commerce\",\n \"payment_method_name\": \"visa\",\n \"pending_url\": \"https://www.test.com\",\n \"plan_id\": \"PL-532332\",\n \"shipping_address_city\": \"NEUILLY-SUR-SEINEs\",\n \"shipping_address_country\": \"FR\",\n \"shipping_address_first_use_date\": \"2020-03-19T00:00:00.000Z\",\n \"shipping_address_street_name_line1\": \"16 rue de Raymond Poincaré\",\n \"shipping_address_street_name_line2\": null,\n \"shipping_address_zip_code\": \"92200\",\n \"shipping_carrier_name\": \"DHL\",\n \"shipping_delivery_method\": \"customer_address\",\n \"shipping_delivery_range\": \"sameday\",\n \"shipping_first_name\": \"\",\n \"shipping_id\": \"318378289489\",\n \"shipping_last_name\": \"\",\n \"shipping_phone_number\": \"\",\n \"shipping_price\": 20,\n \"shipping_tax\": 5,\n \"status\": \"created\",\n \"subscriber_id\": \"SBE-532332\",\n \"subscription_description\": \"3 months waranty\",\n \"website_url\": \"www.exemple.com\",\n \"checkout_id\": \"652ff161fadcf444bedb4f65\"\n },\n \"payment_methods\": {\n \"payment_methods_available\": [\n {\n \"component_type\": \"card\",\n \"countries\": [\n \"all\"\n ],\n \"display_name\": \"Visa\",\n \"form_fields\": [\n {\n \"name\": \"card_number\",\n \"label\": \"card_number\",\n \"display_name\": \"card_number\",\n \"data_type\": \"integer\",\n \"enum\": [],\n \"example\": \"4111 xxxx xxxx xxxx\"\n },\n {\n \"name\": \"cvc\",\n \"label\": \"cvc\",\n \"display_name\": \"cvc\",\n \"data_type\": \"integer\",\n \"enum\": [],\n \"example\": \"123\"\n },\n {\n \"name\": \"card_validity\",\n \"label\": \"card_validity\",\n \"display_name\": \"card_validity\",\n \"data_type\": \"date\",\n \"enum\": [],\n \"example\": \"MM/YY\"\n },\n {\n \"name\": \"cardholder_name\",\n \"label\": \"cardholder_name\",\n \"display_name\": \"cardholder_name\",\n \"data_type\": \"name\",\n \"enum\": [],\n \"example\": \"Mickael Smith\"\n }\n ],\n \"logo\": \"visa.svg\",\n \"logo_png\": \"visa.png\",\n \"logo_colorbg\": \"Visa_colorbg.svg\",\n \"logo_colorbg_png\": \"Visa_colorbg@2x.png\",\n \"logo_favicon_colorbg\": \"Visa_favicon_colorbg.svg\",\n \"logo_favicon_colorbg_png\": \"Visa_favicon_colorbg@2x.png\",\n \"logo_favicon_whitebg\": \"Visa_favicon_whitebg.svg\",\n \"logo_favicon_whitebg_png\": \"Visa_favicon_whitebg@2x.png\",\n \"logo_white\": \"Visa_white.svg\",\n \"logo_white_png\": \"Visa_white@2x.png\",\n \"logo_whitebg\": \"Visa_whitebg.svg\",\n \"logo_whitebg_png\": \"Visa_whitebg@2x.png\",\n \"name\": \"visa\",\n \"partner\": \"checkout\",\n \"required_fields\": [\n \"payment_method_name\",\n \"token\",\n \"amount\",\n \"currency\"\n ]\n }\n ],\n \"payment_methods_saved\": [\n {\n \"component_type\": \"card\",\n \"countries\": [\n \"all\"\n ],\n \"display_name\": \"Visa\",\n \"form_fields\": [\n {\n \"name\": \"card_number\",\n \"label\": \"card_number\",\n \"display_name\": \"card_number\",\n \"data_type\": \"integer\",\n \"enum\": [],\n \"example\": \"4111 xxxx xxxx xxxx\"\n },\n {\n \"name\": \"cvc\",\n \"label\": \"cvc\",\n \"display_name\": \"cvc\",\n \"data_type\": \"integer\",\n \"enum\": [],\n \"example\": \"123\"\n },\n {\n \"name\": \"card_validity\",\n \"label\": \"card_validity\",\n \"display_name\": \"card_validity\",\n \"data_type\": \"date\",\n \"enum\": [],\n \"example\": \"MM/YY\"\n },\n {\n \"name\": \"cardholder_name\",\n \"label\": \"cardholder_name\",\n \"display_name\": \"cardholder_name\",\n \"data_type\": \"name\",\n \"enum\": [],\n \"example\": \"Mickael Smith\"\n }\n ],\n \"logo\": \"visa.svg\",\n \"logo_png\": \"visa.png\",\n \"logo_colorbg\": \"Visa_colorbg.svg\",\n \"logo_colorbg_png\": \"Visa_colorbg@2x.png\",\n \"logo_favicon_colorbg\": \"Visa_favicon_colorbg.svg\",\n \"logo_favicon_colorbg_png\": \"Visa_favicon_colorbg@2x.png\",\n \"logo_favicon_whitebg\": \"Visa_favicon_whitebg.svg\",\n \"logo_favicon_whitebg_png\": \"Visa_favicon_whitebg@2x.png\",\n \"logo_white\": \"Visa_white.svg\",\n \"logo_white_png\": \"Visa_white@2x.png\",\n \"logo_whitebg\": \"Visa_whitebg.svg\",\n \"logo_whitebg_png\": \"Visa_whitebg@2x.png\",\n \"name\": \"visa\",\n \"partner\": \"checkout\",\n \"required_fields\": [\n \"payment_method_name\",\n \"token\",\n \"amount\",\n \"currency\"\n ],\n \"id\": \"63e112302c34b18c94c9a1f5\",\n \"nb_use\": 1,\n \"date_last_use\": \"2023-02-06T14:44:00.615Z\",\n \"token\": \"78eed88ab5f60ff92904f4298977b8e609d7d48788265e8af056446e28c7ffd2\",\n \"payment_details\": [\n {\n \"key\": \"last_4_digits\",\n \"value\": \"4242\"\n },\n {\n \"key\": \"first_6_digits\",\n \"value\": \"424242\"\n },\n {\n \"key\": \"card_validity_month\",\n \"value\": \"02\"\n },\n {\n \"key\": \"card_validity_year\",\n \"value\": \"25\"\n }\n ]\n }\n ],\n \"payment_methods_used\": [\n {\n \"component_type\": \"card\",\n \"countries\": [\n \"all\"\n ],\n \"display_name\": \"Visa\",\n \"form_fields\": [\n {\n \"name\": \"card_number\",\n \"label\": \"card_number\",\n \"display_name\": \"card_number\",\n \"data_type\": \"integer\",\n \"enum\": [],\n \"example\": \"4111 xxxx xxxx xxxx\"\n },\n {\n \"name\": \"cvc\",\n \"label\": \"cvc\",\n \"display_name\": \"cvc\",\n \"data_type\": \"integer\",\n \"enum\": [],\n \"example\": \"123\"\n },\n {\n \"name\": \"card_validity\",\n \"label\": \"card_validity\",\n \"display_name\": \"card_validity\",\n \"data_type\": \"date\",\n \"enum\": [],\n \"example\": \"MM/YY\"\n },\n {\n \"name\": \"cardholder_name\",\n \"label\": \"cardholder_name\",\n \"display_name\": \"cardholder_name\",\n \"data_type\": \"name\",\n \"enum\": [],\n \"example\": \"Mickael Smith\"\n }\n ],\n \"logo\": \"visa.svg\",\n \"logo_png\": \"visa.png\",\n \"logo_colorbg\": \"Visa_colorbg.svg\",\n \"logo_colorbg_png\": \"Visa_colorbg@2x.png\",\n \"logo_favicon_colorbg\": \"Visa_favicon_colorbg.svg\",\n \"logo_favicon_colorbg_png\": \"Visa_favicon_colorbg@2x.png\",\n \"logo_favicon_whitebg\": \"Visa_favicon_whitebg.svg\",\n \"logo_favicon_whitebg_png\": \"Visa_favicon_whitebg@2x.png\",\n \"logo_white\": \"Visa_white.svg\",\n \"logo_white_png\": \"Visa_white@2x.png\",\n \"logo_whitebg\": \"Visa_whitebg.svg\",\n \"logo_whitebg_png\": \"Visa_whitebg@2x.png\",\n \"name\": \"visa\",\n \"partner\": \"checkout\",\n \"required_fields\": [\n \"payment_method_name\",\n \"token\",\n \"amount\",\n \"currency\"\n ],\n \"nb_use\": 30,\n \"date_last_use\": \"2023-02-08T09:13:26.364Z\"\n }\n ]\n }\n}"},{"id":"9c044405-c5fd-43e6-ba39-bedfa52c71ff","name":"Create checkout for type Hosted Page","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"{{apiKey}}","type":"text"},{"key":"version","value":"1.0.0","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": \"hosted_page\",\n \"locale\": \"fr_FR\",\n \"payment_method_name\": \"visa\",\n \"operation_type\":\"authorize\",\n \"amount\": 68.18,\n \"currency\": \"EUR\",\n \"order_merchant_id\": \"276398531664\",\n \"payment_channel\": \"e-commerce\",\n \"website_url\": \"https://www.example.com/\",\n \"cancel_url\": \"https://www.google.com/search?q=cancel\",\n \"device_type\": \"mobile\",\n \"customer_id\": \"4025251046660958\",\n \"customer_email\": \"kirby.nash@gmail.com\",\n \"customer_first_name\": \"Kirby\",\n \"customer_last_name\": \"Nash\",\n \"customer_identification_number\": \"GTF730340H7\",\n \"customer_gender\": \"female\",\n \"customer_street_name\": \"37 rue du Président Roosevelt\",\n \"customer_city\": \"SARTROUVILLE\",\n \"customer_zip_code\": \"78500\",\n \"customer_country\": \"FR\",\n \"customer_ip\": \"203.200.6.117\",\n \"customer_billing_first_name\": \"Kirby\",\n \"customer_billing_last_name\": \"Nash\",\n \"customer_billing_street_name\": \"37 rue du Président Roosevelt\",\n \"customer_billing_city\": \"SARTROUVILLE\",\n \"customer_billing_zip_code\": \"78500\",\n \"customer_billing_country\": \"FR\",\n \"customer_birth_date\": \"2020-06-22\",\n \"customer_phone_number\": \"0686606737\",\n \"customer_phone_number_type\": \"mobile\",\n \"is_customer_registered\": true,\n \"customer_account_creation_date\": \"2020-03-19\",\n \"customer_account_change_date\": \"2020-06-18\",\n \"customer_account_change_password_date\": \"2020-06-18\",\n \"customer_account_attempts_order_day\": \"1\",\n \"customer_account_attempts_order_six_months\": \"6\",\n \"customer_account_attempts_order_year\": \"8\",\n \"customer_account_successful_orders_day\": \"1\",\n \"customer_account_successful_orders_six_months\": \"5\",\n \"customer_account_successful_orders_year\": \"7\",\n \"customer_account_add_payment_means_date\": \"2020-06-18\",\n \"customer_browser_info_color_depth\": \"test1\",\n \"customer_browser_info_accept_header\": \"test2\",\n \"customer_browser_info_java_enabled\": true,\n \"customer_browser_info_js_enabled\": false,\n \"customer_browser_info_language\": \"FR\",\n \"customer_browser_info_screen_height\": 119,\n \"customer_browser_info_screen_width\": 333,\n \"customer_browser_info_time_zone\": \"+01:00\",\n \"customer_browser_info_user_agent\": \"Mozilla---\",\n \"is_return_accepted\": true,\n \"basket_id\": \"BSK-5942478750\",\n \"basket_type\": \"physical\",\n \"basket_content\": [\n {\n \"product_sku\": \"TSH-MED-WHI-COT\",\n \"product_id\": \"39851062\",\n \"product_name\": \"Tee Shirt MED\",\n \"product_description\": \"White tee shirt, size M\",\n \"product_price\": \"20.00\",\n \"product_quantity\": \"2\",\n \"product_availability\": true,\n \"product_type\": \"physical\",\n \"product_tax_amount\": \"4.14\",\n \"total_amount\": \"44.14\",\n \"seller_id\": \"SEL-07428099\",\n \"seller_name\": \"nounplus\",\n \"seller_commission\": \"4.41\"\n },\n {\n \"product_sku\": \"DRE-MED-RED-LEA\",\n \"product_id\": \"40547343\",\n \"product_name\": \"Dress MED\",\n \"product_description\": \"Red dress, size M\",\n \"product_price\": \"22\",\n \"product_quantity\": \"1\",\n \"product_availability\": true,\n \"product_type\": \"physical\",\n \"product_tax_amount\": \"2.04\",\n \"total_amount\": \"24.04\",\n \"seller_id\": \"SEL-54539757\",\n \"seller_name\": \"faruber\",\n \"seller_commission\": \"2.4\"\n }\n ],\n \"shipping_id\": \"318378289489\",\n \"shipping_carrier_name\": \"DHL\",\n \"shipping_delivery_range\": \"sameday\",\n \"shipping_delivery_method\": \"customer_address\",\n \"shipping_price\": 20,\n \"shipping_tax\": 5,\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_phone_number\": \"\",\n \"shipping_address_street_name_line1\": \"16 rue de Raymond Poincaré\",\n \"shipping_address_street_name_line2\": null,\n \"shipping_address_city\": \"NEUILLY-SUR-SEINEs\",\n \"shipping_address_zip_code\": \"92200\",\n \"shipping_address_country\": \"FR\",\n \"shipping_address_first_use_date\": \"2020-03-19\",\n \"plan_id\": \"PL-532332\",\n \"contract_id\": \"CT-532332\",\n \"subscriber_id\": \"SBE-532332\",\n \"subscription_description\": \"3 months waranty\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiUrl}}/payment/checkout"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"environment","value":"{{environment}}","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"code\": \"011111\",\n \"description\": \"checkout created successfully\"\n },\n \"redirect_url\": \"https://securepay-sandbox.norbr.com/d7b455b1c3fa3ff68da50e64db9ebec37e5497f1e0308fcb732d8fa3f20f49cc\",\n \"checkout\": {\n \"accept_url\": \"https://www.test.com\",\n \"amount\": 68.18,\n \"basket_content\": [\n {\n \"product_availability\": true,\n \"product_description\": \"White tee shirt, size M\",\n \"product_id\": \"39851062\",\n \"product_name\": \"Tee Shirt MED\",\n \"product_price\": 20,\n \"product_quantity\": 2,\n \"product_sku\": \"TSH-MED-WHI-COT\",\n \"product_tax_amount\": 4.14,\n \"product_type\": \"physical\",\n \"seller_commission\": 4.41,\n \"seller_id\": \"SEL-07428099\",\n \"seller_name\": \"nounplus\",\n \"total_amount\": 44.14\n },\n {\n \"product_availability\": true,\n \"product_description\": \"Red dress, size M\",\n \"product_id\": \"40547343\",\n \"product_name\": \"Dress MED\",\n \"product_price\": 22,\n \"product_quantity\": 1,\n \"product_sku\": \"DRE-MED-RED-LEA\",\n \"product_tax_amount\": 2.04,\n \"product_type\": \"physical\",\n \"seller_commission\": 2.4,\n \"seller_id\": \"SEL-54539757\",\n \"seller_name\": \"faruber\",\n \"total_amount\": 24.04\n }\n ],\n \"basket_id\": \"BSK-5942478750\",\n \"basket_type\": \"physical\",\n \"cancel_url\": \"https://www.google.com/search?q=cancel\",\n \"contract_id\": \"CT-532332\",\n \"currency\": \"EUR\",\n \"customer_account_add_payment_means_date\": \"2020-06-18T00:00:00.000Z\",\n \"customer_account_attempts_order_day\": 1,\n \"customer_account_attempts_order_six_months\": 6,\n \"customer_account_attempts_order_year\": 8,\n \"customer_account_change_date\": \"2020-06-18T00:00:00.000Z\",\n \"customer_account_change_password_date\": \"2020-06-18T00:00:00.000Z\",\n \"customer_account_creation_date\": \"2020-03-19T00:00:00.000Z\",\n \"customer_account_successful_orders_day\": 1,\n \"customer_account_successful_orders_six_months\": 5,\n \"customer_account_successful_orders_year\": 7,\n \"customer_billing_city\": \"SARTROUVILLE\",\n \"customer_billing_country\": \"FR\",\n \"customer_billing_first_name\": \"Kirby\",\n \"customer_billing_last_name\": \"Nash\",\n \"customer_billing_street_name\": \"37 rue du Président Roosevelt\",\n \"customer_billing_zip_code\": \"78500\",\n \"customer_birth_date\": \"2020-06-22T00:00:00.000Z\",\n \"customer_browser_info_accept_header\": \"test2\",\n \"customer_browser_info_color_depth\": \"test1\",\n \"customer_browser_info_java_enabled\": true,\n \"customer_browser_info_js_enabled\": false,\n \"customer_browser_info_language\": \"FR\",\n \"customer_browser_info_screen_height\": 119,\n \"customer_browser_info_screen_width\": 333,\n \"customer_browser_info_time_zone\": \"Paris/London\",\n \"customer_browser_info_user_agent\": \"Mozilla---\",\n \"customer_city\": \"SARTROUVILLE\",\n \"customer_country\": \"FR\",\n \"customer_email\": \"kirby.nash@gmail.com\",\n \"customer_first_name\": \"Kirby\",\n \"customer_gender\": \"female\",\n \"customer_id\": \"4025251046660958\",\n \"customer_identification_number\": \"GTF730340H7\",\n \"customer_ip\": \"203.200.6.117\",\n \"customer_last_name\": \"Nash\",\n \"customer_phone_number\": \"0686606737\",\n \"customer_phone_number_type\": \"mobile\",\n \"customer_street_name\": \"37 rue du Président Roosevelt\",\n \"customer_zip_code\": \"78500\",\n \"decline_url\": \"https://www.test.com\",\n \"device_type\": \"mobile\",\n \"exception_url\": \"https://www.test.com\",\n \"expiration_date\": \"2023-10-18T15:09:03.668Z\",\n \"is_customer_registered\": true,\n \"is_return_accepted\": true,\n \"locale\": \"fr-FR\",\n \"operation_type\": \"authorize\",\n \"order_merchant_id\": \"276398531664\",\n \"token_type\": \"oneshot\",\n \"type\": \"hosted_page\",\n \"payment_channel\": \"e-commerce\",\n \"payment_method_name\": \"visa\",\n \"pending_url\": \"https://www.test.com\",\n \"plan_id\": \"PL-532332\",\n \"shipping_address_city\": \"NEUILLY-SUR-SEINEs\",\n \"shipping_address_country\": \"FR\",\n \"shipping_address_first_use_date\": \"2020-03-19T00:00:00.000Z\",\n \"shipping_address_street_name_line1\": \"16 rue de Raymond Poincaré\",\n \"shipping_address_street_name_line2\": null,\n \"shipping_address_zip_code\": \"92200\",\n \"shipping_carrier_name\": \"DHL\",\n \"shipping_delivery_method\": \"customer_address\",\n \"shipping_delivery_range\": \"sameday\",\n \"shipping_first_name\": \"\",\n \"shipping_id\": \"318378289489\",\n \"shipping_last_name\": \"\",\n \"shipping_phone_number\": \"\",\n \"shipping_price\": 20,\n \"shipping_tax\": 5,\n \"status\": \"created\",\n \"subscriber_id\": \"SBE-532332\",\n \"subscription_description\": \"3 months waranty\",\n \"website_url\": \"www.exemple.com\",\n \"checkout_id\": \"652ff18bfadcf444bedb4f83\"\n }\n}"}],"_postman_id":"655b176e-ec23-4221-9942-56536a88c33b"}],"id":"fcff5565-e539-417e-af33-afd1c1026ee4","description":"Use this endpoint to build and customize your checkout depending on your customer specific situation and always be up to date between your payment stack and your payment page without further development.
\nUse the checkout_id from the response when initiating the .js and directly see the result on your checkout page.
\nOr use all the information from the response to build your own page with the required fields and logos for each payment methods.
\n","_postman_id":"fcff5565-e539-417e-af33-afd1c1026ee4"},{"name":"Order","item":[{"name":"Create an order","id":"0c45859a-1e6a-4ae8-86f4-4499d16f5265","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"Private api key"},{"key":"version","value":"1.0.0"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"operation_type","value":"","description":"(Required) Specify the kind of order you want to create: authorize or direct_capture
\n","type":"text"},{"key":"token","value":"","description":"(Required) Given in response to the /payment/token request
\n","type":"text"},{"key":"checkout_id","value":"","description":"(Required) Specify the id of the checkout previously created.
\n","type":"text"},{"key":"merchant_contract","value":"","description":"The merchant contract id is used to process the transaction. You will find this information in your OnRamp account
\n","type":"text"},{"key":"payment_method_name","value":" ","description":"The name of the method used by the customer to pay this order. Please refer to the APM folder
\n","type":"text"},{"key":"amount","value":"","description":"(Required) A positive number with 3 decimals digit max to describe the charge of the order.
\n","type":"text"},{"key":"currency","value":"","description":"(Required) The 3-letter ISO currency code refering to the authorization currency
\n","type":"text"},{"key":"order_merchant_id","value":"","description":"(Required) Unique identifier used by the merchant for an order
\n","type":"text"},{"key":"payment_channel","value":"","description":"(Required) Describes where the transaction is taking place : e-commerce, recurring, moto, pos
\n","type":"text"},{"key":"website_url","value":"","description":"The website where the order was issued.
\n","type":"text"},{"key":"customer_id","value":"","description":"The unique identifier of the customer.
\n","type":"text"},{"key":"customer_email","value":"","description":"The customer's e-mail address.
\n","type":"text"},{"key":"customer_first_name","value":"","description":"The customer's first name.
\n","type":"text"},{"key":"customer_last_name","value":"","description":"The customer's last name.
\n","type":"text"},{"key":"customer_street_name","value":"","description":"The customer's address.
\n","type":"text"},{"key":"customer_city","value":"","description":"The customer's city.
\n","type":"text"},{"key":"customer_zip_code","value":"","description":"The customer's zip code.
\n","type":"text"},{"key":"customer_country","value":"","description":"The 2-letter ISO country code referring to the customer's country
\n","type":"text"},{"key":"customer_ip","value":"","description":"The customer's ip address.
\n","type":"text"},{"key":"accept_url","value":"","description":"URL to redirect your customer to once the payment process is completed successfully.
\n","type":"text"},{"key":"decline_url","value":"","description":"URL to redirect your customer to after the payment is declined.
\n","type":"text"},{"key":"pending_url","value":"","description":"URL to redirect your customer to when the payment request was processed but response is not yet available
\n","type":"text"},{"key":"exception_url","value":"","description":"URL to redirect your customer to after a system failure.
\n","type":"text"}]},"url":"{{apiUrl}}/payment/order","description":"The /payment/order request handles different use cases and accepts numerous information about your customer, the basket, the shipping or the order itself.
\nA successful order created with the operation_type=authorize will only block the funds on your customer bank account but won't debit the account. In order to debit your customer bank account and receive the funds, you will need to use the payment/maintenance endpoint to capture the corresponding amount.
\nIf you wish to send the debit request directly with the authorization request, you need to set the field operation_type=direct_capture.
\nUse the payment_method_name to choose the payment method you want, be aware that you need at least one partner account with the payment method activated to be able to process it.
Go to the Payment Networks page on your OnRamp account to check if it's activated, or add a partner account with the specific payment method, and go to our APM folder to check how to ask for a specific payment method.
\n","urlObject":{"path":["payment","order"],"host":["{{apiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"bb44c4e4-e2ec-4d36-be8a-6540f2585993","name":"Create an order card","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"YOUR_PRIVATE_API_KEY","type":"text"},{"key":"version","value":"1.0.0","type":"text"}],"body":{"mode":"raw","raw":"{\n \"operation_type\": \"authorize\",\n \"token\": \"b65ab7f6099b1fd8e357ea319dc851f70daebe9e333be065a23d8239130089c3\",\n \"merchant_contract\": \"608526227b9daa000b8c0174\",\n \"checkout_id\": \"67ceb0cb9af8068910f8a752\",\n \"payment_method_name\": \"visa\",\n \"amount\": 68.18,\n \"currency\": \"EUR\",\n \"order_merchant_id\": \"276398531664\",\n \"payment_channel\": \"e-commerce\",\n \"website_url\": \"https://www.example.com/\",\n \"customer_id\": \"4025251046660958\",\n \"customer_email\": \"kirby.nash@gmail.com\",\n \"customer_first_name\": \"Kirby\",\n \"customer_last_name\": \"Nash\",\n \"customer_street_name\": \"37 rue du Président Roosevelt\",\n \"customer_city\": \"SARTROUVILLE\",\n \"customer_zip_code\": \"78500\",\n \"customer_country\": \"FR\",\n \"customer_ip\": \"127.0.0.1\",\n \"order_description\":\"1 jean t.38\",\n \"accept_url\": \"https://www.google.com/search?q=accept\",\n \"decline_url\": \"https://www.google.com/search?q=decline\",\n \"pending_url\": \"https://www.google.com/search?q=pendind\",\n \"exception_url\": \"https://www.google.com/search?q=exception\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.onramppay.com/payment/order"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"environment","value":"sandbox","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"code\": \"944444\",\n \"description\": \"authorization successful\"\n },\n \"order_id\": \"60d1d672d0a0c2000cff7eae\",\n \"status\": \"authorization_successful\",\n \"payment_method_name\": \"visa\",\n \"order_amount\": 68.18,\n \"order_currency\": \"EUR\",\n \"order_merchant_id\": \"276398531664\",\n \"payment_channel\": \"e-commerce\",\n \"website_url\": \"www.exemple.com\",\n \"customer_id\": \"4025251046660958\",\n \"customer_email\": \"kirby.nash@gmail.com\",\n \"customer_first_name\": \"Kirby\",\n \"customer_last_name\": \"Nash\",\n \"customer_street_name\": \"37 rue du Président Roosevelt\",\n \"customer_city\": \"SARTROUVILLE\",\n \"customer_zip_code\": \"\",\n \"customer_country\": \"\",\n \"customer_ip\": \"127.0.0.1\",\n \"order_description\": \"1 jean t.38\",\n \"is_suspicious\": false,\n \"risk_assessment_partner\": \"Checkout\",\n \"risk_assessment_date\": \"2021-06-22T12:24:35.508Z\",\n \"risk_assessment_result\": \"accepted\",\n \"risk_assessment_reason\": \"\",\n \"risk_assessment_reason_code\": \"\",\n \"is_authenticated\": false,\n \"authentication_indicator\": \"ask_3ds\",\n \"authentication_partner\": \"Checkout\",\n \"authentication_date\": null,\n \"authentication_result\": \"\",\n \"authorization_date\": \"2021-06-22T12:24:18.243Z\",\n \"authorization_result\": \"authorization_successful\",\n \"authorization_code\": \"pay_o4j7rzswitkkzmb6qo2wnheczm\",\n \"authorization_amount\": 68.18,\n \"is_captured\": false,\n \"capture_date\": null,\n \"capture_result\": \"\",\n \"capture_total_amount\": \"\",\n \"is_refunded\": false,\n \"refund_date\": null,\n \"refund_result\": \"\",\n \"refund_total_amount\": \"\",\n \"is_cancelled\": false,\n \"cancellation_date\": null,\n \"cancellation_result\": \"\",\n \"payin_partner\": \"Checkout\",\n \"merchant_contract_id\": \"608526227b9daa000b8c0174\",\n \"psp_result_code\": \"\",\n \"psp_result_description\": \"\"\n}"}],"_postman_id":"0c45859a-1e6a-4ae8-86f4-4499d16f5265"},{"name":"Update an order","id":"c0acea8d-637c-458d-b189-c936fc51044e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"x-api-key","value":"Private api key","type":"text"},{"key":"version","value":"1.0.0","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"payment_method_name","value":"","description":"The name of the method used by the customer to pay this order. Please refer to the APM folder
\n","type":"text"},{"key":"token","value":"","description":"(Required) Given in response to the /payment/token request
\n","type":"text"},{"key":"operation_type","value":"","description":"Specify the kind of order you want to create: authorize or direct_capture
\n","type":"text"},{"key":"customer_ip","value":"","description":"The customer's ip address.
\n","type":"text"},{"key":"authentication_indicator","value":"","description":"Selects the authentication scenario you want applied for this order : no_3ds, ask_3ds, force_3ds
\n","type":"text"},{"key":"payment_channel","value":"","description":"Describes where the transaction is taking place : e-commerce, moto, pos
\n","type":"text"},{"key":"merchant_contract","value":"","description":"The merchant contract id used to process the transaction. You will find this information in your OnRamp account.
\n","type":"text"}]},"url":"{{apiUrl}}/payment/order/{{order_id}}","description":"Use this method to update an order previously created but not successful.
\nAll the following information can be updated :
\n\n- Operation type (mandatory)
\n- Token
\n- Payment channel (mandatory)
\n- Authentication indicator
\n- Payment method
\n- Customer's IP
\n- Merchant contract
\n
\nBasket content and customer information (except ip address) can not be updated via this method, a new order will have to be created if these information must be changed.
\n","urlObject":{"path":["payment","order","{{order_id}}"],"host":["{{apiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"0bee3228-4ee5-4c42-a67b-246f32798c4d","name":"Update an order","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"YOUR_PRIVATE_API_KEY","type":"text"},{"key":"version","value":"1.0.0","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"operation_type\": \"direct_capture\",\n\t\"token\": \"e131ae61-54dd-4877-be66-50008fd7735c\",\n \"payment_channel\": \"e-commerce\",\n\t\"payment_method_name\": \"visa\",\n\t\"authentication_indicator\": \"no_3ds\",\n \"customer_ip\": \"127.0.0.1\",\n \"merchant_contract\": \"5fa03b55e394b7a83c5f2d94\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.onramppay.com/payment/order/123456789765"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"environment","value":"sandbox","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"code\": \"9555555\",\n \"description\": \"Capture requested\"\n },\n \"order_id\": \"5fcf442a152c98000a12b66b\",\n \"status\": \"capture_requested\",\n \"payment_method_name\": \"visa\",\n \"order_amount\": 17.12,\n \"order_currency\": \"EUR\",\n \"order_merchant_id\": \"111112223\",\n \"payment_channel\": \"e-commerce\",\n \"website_url\": \"www.exemple.com\",\n \"customer_id\": \"4025251046660958\",\n \"customer_email\": \"kirby.nash@gmail.com\",\n \"customer_first_name\": \"Kirby\",\n \"customer_last_name\": \"Nash\",\n \"customer_street_name\": \"37 rue du Président Roosevelt\",\n \"customer_city\": \"SARTROUVILLE\",\n \"customer_zip_code\": \"78500\",\n \"customer_country\": \"FR\",\n \"customer_ip\": \"127.0.0.1\",\n \"order_description\":\"1 jean t.38\",\n \"is_suspicious\": false,\n \"risk_assessment_partner\": \"checkout\",\n \"risk_assessment_date\": \"2020-12-08T09:15:22.767Z\",\n \"risk_assessment_result\": \"accepted\",\n \"risk_assessment_reason\": \"\",\n \"risk_assessment_reason_code\": \"\",\n \"is_authenticated\": false,\n \"authentication_indicator\": \"no_3ds\",\n \"authentication_partner\": \"\",\n \"authentication_date\": null,\n \"authentication_result\": \"\",\n \"authorization_date\": \"2020-12-08T09:15:22.767Z\",\n \"authorization_result\": \"capture_requested\",\n \"authorization_code\": \"\",\n \"authorization_amount\": 17.12,\n \"is_captured\": false,\n \"capture_date\": null,\n \"capture_result\": \"capture_requested\",\n \"capture_amount\": 17.12,\n \"capture_total_amount\": \"\",\n \"payin_partner\": \"Checkout\",\n \"merchant_contract_id\": \"5fa03b55e394b7a83c5f2d94\",\n \"psp_result_code\": \"\",\n \"psp_result_description\": \"\"\n}"}],"_postman_id":"c0acea8d-637c-458d-b189-c936fc51044e"},{"name":"Retrieve an order","event":[{"listen":"test","script":{"exec":["//Healthcheck","pm.test(\"Status code is 200\", function () { pm.response.to.have.status(200);});","","pm.test(\"Payment product should be equal ENV randomPaymentProduct\", function () {"," pm.expect( pm.response.json().payment_data.payment_product).to.eql(pm.environment.get(\"randomPaymentProduct\"));","});","","pm.test(\"Token should be equal ENV token\", function () {"," pm.expect(pm.response.json().payment_data.token).to.eql(pm.environment.get(\"token\"));","});","","pm.test(\"MID should be equal ENV mid\", function () {"," pm.expect(pm.response.json().mid).to.eql(pm.environment.get(\"mid\"));","});","","/*pm.test(\"ProviderID should be equal ENV provider_id\", function () {"," pm.expect(pm.response.json().provider_id).to.eql(pm.environment.get(\"provider_id\"));","});*/","","pm.test(\"_id should be equal ENV order_id\", function () {"," pm.expect(pm.response.json()._id).to.eql(pm.environment.get(\"order_id\"));","});"],"type":"text/javascript","id":"d7bfadb3-fee2-4a44-8414-0b476b00a44d"}}],"id":"4f705041-0e55-4508-95ef-4ef57bfc9f5f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"Private api key","type":"text"},{"key":"version","value":"1.0.0","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{apiUrl}}/payment/order/{{order_id}}","description":"Retrieve all the information stored on the order via its identifier returned as the order_id.
\nIt will provide in response all the information related to the order and its latest status at the time of the request.
\nThe information retrieved includes the steps the order went through and their details for authentication, authorization, capture and refund.
\n","urlObject":{"path":["payment","order","{{order_id}}"],"host":["{{apiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"d9d6042a-9402-4232-82c1-e4035e8af52c","name":"Get information order","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"YOUR_PRIVATE_API_KEY","type":"text"},{"key":"version","value":"1.0.0","type":"text"}],"url":"https://api-sandbox.onramppay.com/payment/order/607ef8b3423a54000a8caba9"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"environment","value":"sandbox","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"{{order_id}}\",\n \"type\": \"direct_capture\",\n \"currency\": \"EUR\",\n \"amount\": 26,\n \"giftcard_used\": false,\n \"order_merchant_id\": \"276398531664\",\n \"baskets\": [],\n \"attempts_remaining\": 2,\n \"merchant_account\": \"615f3066c67357000ad556e1\",\n \"merchant_data\": [],\n \"createdAt\": \"2022-02-06T15:38:23.630Z\",\n \"createdBy\": {\n \"name\": \"Test Sandbox\"\n },\n \"transactions\": [\n {\n \"id\": \"63e11eef2c34b18c94c9b1ac\",\n \"type\": \"authorize\",\n \"amount\": 26,\n \"currency\": \"EUR\",\n \"status\": \"authorization_declined\",\n \"authentication_indicator\": \"no_3ds\",\n \"authentication_partner\": null,\n \"authentication_partner_api_name\": null,\n \"authentication_request_date\": null,\n \"authentication_request_status\": null,\n \"authentication_date\": null,\n \"authentication_result\": null,\n \"authorization_status\": \"authorization_declined\",\n \"authorization_request_date\": \"2022-02-06T15:38:23.640Z\",\n \"authorization_request_status\": \"authorization_requested\",\n \"authorization_result\": \"failure\",\n \"cancellation_request_date\": null,\n \"cancellation_request_status\": null,\n \"cancellation_date\": null,\n \"cancellation_status\": null,\n \"cancellation_result\": null,\n \"capture_request_date\": null,\n \"capture_request_status\": null,\n \"capture_date\": null,\n \"capture_status\": null,\n \"capture_result\": null,\n \"refund_date\": null,\n \"refund_request_date\": null,\n \"refund_request_status\": null,\n \"refund_status\": null,\n \"refund_result\": null,\n \"refund_reason\": null,\n \"payin_partner\": \"Checkout\",\n \"psp_transaction_id\": \"pay_55jc5p4puvnkjabfm6a5ejn3ka\",\n \"psp_token\": \"src_yitkciwzwwhe3k7awp4dzqqraq\",\n \"operations\": [\n {\n \"_id\": \"63e11eef2c34b18c94c9b1ad\",\n \"type\": \"risk_assessment\",\n \"request_date\": \"2022-02-06T15:38:23.637Z\",\n \"request_status\": \"risk_assessment_requested\",\n \"amount\": 26,\n \"currency\": \"EUR\",\n \"transaction\": \"63e11eef2c34b18c94c9b1ac\",\n \"merchant_account\": \"615f3066c67357000ad556e1\",\n \"createdBy\": \"61b9060f18af3b000a87c5f7\",\n \"createdAt\": \"2022-02-06T15:38:23.637Z\",\n \"updatedAt\": \"2022-02-06T15:38:26.033Z\",\n \"result_date\": \"2022-02-06T15:38:26.017Z\",\n \"result_status\": \"risk_assessment_approved\",\n \"result_response\": \"accepted\",\n \"partner_operation_id\": \"act_55jc5p4puvnkjabfm6a5ejn3ka\",\n \"partner_result_code\": \"20005\",\n \"partner_result_description\": \"Declined - Do Not Honour\",\n \"request_result_date\": \"2022-02-06T15:38:24.907Z\",\n \"updatedBy\": \"61a90ddbc96731000a7ea91e\",\n \"request_id\": \"63e11eef2c34b18c94c9b1ad\"\n },\n {\n \"_id\": \"63e11eef2c34b18c94c9b1af\",\n \"type\": \"authorization\",\n \"request_date\": \"2022-02-06T15:38:23.640Z\",\n \"request_status\": \"authorization_requested\",\n \"amount\": 26,\n \"currency\": \"EUR\",\n \"transaction\": \"63e11eef2c34b18c94c9b1ac\",\n \"merchant_account\": \"615f3066c67357000ad556e1\",\n \"createdBy\": \"61b9060f18af3b000a87c5f7\",\n \"createdAt\": \"2022-02-06T15:38:23.641Z\",\n \"updatedAt\": \"2022-02-06T15:38:26.033Z\",\n \"request_response\": \"success\",\n \"result_date\": \"2022-02-06T15:38:24.908Z\",\n \"result_status\": \"authorization_declined\",\n \"result_response\": \"failure\",\n \"partner_operation_id\": \"act_55jc5p4puvnkjabfm6a5ejn3ka\",\n \"partner_result_code\": \"20005\",\n \"partner_result_description\": \"Declined - Do Not Honour\",\n \"request_result_date\": \"2022-02-06T15:38:24.908Z\",\n \"updatedBy\": \"61a90ddbc96731000a7ea91e\",\n \"request_id\": \"63e11eef2c34b18c94c9b1af\"\n }\n ],\n \"is_authorized\": false,\n \"is_captured\": false,\n \"is_cancelled\": false,\n \"is_refunded\": false,\n \"is_chargebacked\": false,\n \"is_authenticated\": false,\n \"is_suspicious\": false,\n \"risk_assessment_date\": \"2022-02-06T15:38:23.637Z\",\n \"risk_assessment_partner\": \"Checkout\",\n \"risk_assessment_partner_api_name\": \"checkout\",\n \"risk_assessment_result\": \"accepted\",\n \"risk_assessment_reason\": null,\n \"risk_assessment_score\": null,\n \"risk_assessment_reason_code\": null,\n \"chargeback_date\": null,\n \"chargeback_reason\": null,\n \"chargeback_reason_code\": null,\n \"chargeback_amount\": null,\n \"customer_ip_country\": \"XX\",\n \"customer_last_name\": \"Nash\",\n \"customer_email\": \"kirby.nash@gmail.com\",\n \"customer_account_creation_date\": null,\n \"customer_account_change_date\": null,\n \"customer_account_change_password_date\": null,\n \"customer_account_attempts_add_card\": null,\n \"customer_account_attempts_order_year\": null,\n \"customer_account_add_payment_means_date\": null,\n \"customer_browser_info_accept_header\": null,\n \"customer_browser_info_color_depth\": null,\n \"customer_browser_info_java_enabled\": null,\n \"customer_browser_info_js_enabled\": null,\n \"customer_browser_info_language\": null,\n \"customer_browser_info_screen_height\": null,\n \"customer_browser_info_screen_width\": null,\n \"customer_browser_info_time_zone\": null,\n \"customer_browser_info_user_agent\": null,\n \"customer_phone_number\": null,\n \"customer_phone_number_type\": null,\n \"customer_street_name\": null,\n \"customer_city\": null,\n \"customer_zip_code\": null,\n \"customer_country\": null,\n \"customer_billing_first_name\": null,\n \"customer_billing_last_name\": null,\n \"customer_billing_street_name\": null,\n \"customer_billing_city\": null,\n \"customer_billing_zip_code\": null,\n \"customer_billing_country\": null,\n \"customer_ip\": \"203.200.6.117\",\n \"token\": \"78eed88ab5f60ff92904f4298977b8e609d7d48788265e8af056446e28c7ffd2\",\n \"payment_channel\": \"e-commerce\",\n \"payment_method_name\": \"visa\",\n \"payment_method_type\": \"card\",\n \"psp_result_code\": \"20005\",\n \"psp_result_description\": \"Declined - Do Not Honour\",\n \"is_order_last_transaction\": true,\n \"is_fallback\": false,\n \"card_6_digits\": \"424242\",\n \"card_4_digits\": \"4242\",\n \"card_issuer\": \"\",\n \"card_country\": \"GB\",\n \"is_new_transaction\": false,\n \"merchant_contract\": \"615f3246c67357000ad55863\",\n \"is_shipping_diff_billing\": null,\n \"is_customer_diff_billing\": null,\n \"is_customer_diff_shipping\": null,\n \"order_merchant_id\": \"276398531664\",\n \"recurring\": true,\n \"occurrence\": \"second\",\n \"status_history\": [\n {\n \"status\": \"created\",\n \"date\": \"2022-02-06T13:00:51.193Z\"\n },\n {\n \"status\": \"risk_assessment_requested\",\n \"date\": \"2022-02-06T15:38:23.639Z\",\n \"request_id\": \"63e11eef2c34b18c94c9b1ad\"\n },\n {\n \"status\": \"authorization_requested\",\n \"date\": \"2022-02-06T15:38:23.641Z\",\n \"request_id\": \"63e11eef2c34b18c94c9b1af\"\n },\n {\n \"status\": \"risk_assessment_approved\",\n \"date\": \"2022-02-06T15:38:24.907Z\",\n \"request_id\": \"63e11eef2c34b18c94c9b1ad\"\n },\n {\n \"status\": \"authorization_declined\",\n \"date\": \"2022-02-06T15:38:24.909Z\",\n \"request_id\": \"63e11eef2c34b18c94c9b1af\"\n }\n ],\n \"authorization_date\": \"2022-02-06T15:38:24.908Z\",\n \"psp_transaction_date\": \"2022-02-06T15:38:24.000Z\",\n \"risk_assessment_partner_id\": \"5fd3780e75179e000a73c0ea\",\n \"captured_amount\": 0,\n \"capture_amount_request\": 0,\n \"amount_formatted\": \"26\",\n \"capturable_amount\": 0,\n \"is_capturable\": false,\n \"refunded_amount\": 0,\n \"refundable_amount\": 0,\n \"refund_amount_request\": 0,\n \"is_refundable\": false,\n \"is_cancellable\": false,\n \"is_multiple_captures_available\": false,\n \"is_partial_capture_available\": true,\n \"is_multiple_refunds_available\": false,\n \"is_partial_refund_available\": true\n }\n ]\n}"}],"_postman_id":"4f705041-0e55-4508-95ef-4ef57bfc9f5f"}],"id":"36f612cc-6736-4fd0-9ff3-6b1c36ac2561","description":"Order objects are created to handle customers' purchases. You can create, retrieve or update an order.
\nThis is a single API that can handle all payment methods and all payment channels.
\nOrders are identified by a unique ID : order_id
\n
\nOrder workflows and status
\n\nEach order will follow a workflow that will give you the useful information to understand exactly what is happening with your order and the different providers used to process it.
\nThe status related to the risk assessment will either come from a specific fraud prevention provider or directly from the payment provider depending on the setup of your OnRamp account.
\n![](\"https://content.pstmn.io/06591fe1-45cc-4399-9825-3ab3ed9b755f/b3JkZXItbm8zRFMuanBn\")
\n\n
\nOperation type
\n\nUse the operation_type field to indicate if you want to capture directly your order or if you only want to do an authorization that you will then capture later.
\nBe aware that an authorization expires and that you will have a limited amount of time to capture your order.
\nAlso, not all payment methods allow delayed capture, please refer to the APM collection to know if it's available or not.
\n
\nTokens
\n\nTokens are only mandatory when trying to process a card order.
\nYou will either have received it after using our hosted elements or the POST payment/token.
\n","_postman_id":"36f612cc-6736-4fd0-9ff3-6b1c36ac2561"},{"name":"Maintenance","item":[{"name":"Capture an order","id":"fc4f966b-5616-41d9-a47b-7c3e9322742b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"Private api key","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"amount","value":"","description":"Amount to be captured. This amount can be inferior to the amount of the order in case of a partial capture
\n"},{"key":"","value":"","description":"","disabled":true},{"key":"","value":"","disabled":true}]},"url":"{{apiUrl}}/payment/maintenance/capture/{{order_id}}","description":"Once your order has been authorized, you can use this request to /capture the funds.
\nYou'll only be able to use this endpoint if your order has not been captured or fully captured yet.
\nIt will give the instruction to the issuer bank (your customer's bank) to pay out the funds previously locked by the authorization.
\nYou can optionally /capture only part of an order. You can do so multiple times, until the entire order has been captured.
\nIf you leave the amount empty, OnRamp will consider this request as a full capture of the order by default.
\n","urlObject":{"path":["payment","maintenance","capture","{{order_id}}"],"host":["{{apiUrl}}"],"query":[{"disabled":true,"key":"order_id","value":""}],"variable":[]}},"response":[{"id":"dae82b56-8bb0-49c1-99b1-c8bedfa13aff","name":"Capture successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","type":"text"},{"key":"x-api-key","value":"YOUR_PRIVATE_API_KEY","type":"text"},{"key":"version","value":"1.0.0","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\":1.15\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.onramppay.com/payment/maintenance/capture/123456789"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"environment","value":"sandbox","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"code\": \"521080\",\n \"description\": \"pending capture request\"\n },\n \"order_id\": \"123456789\",\n \"transaction_id\": \"456789UGFGU876TG\",\n \"status\": \"capture_requested\",\n \"payment_method_name\": \"visa\",\n \"order_amount\": 1.15,\n \"order_currency\": \"EUR\",\n \"order_merchant_id\": \"0001111222\",\n \"is_authenticated\": false,\n \"is_authorized\": true,\n \"capture_date\": \"2022-06-21T13:38:10.766Z\",\n \"capture_request_status\": \"capture_requested\",\n \"captured_amount\": 0,\n \"capturable_amount\": 0,\n \"total_capture_amount_requested\": 1.15,\n \"capture_amount_requested\": 1.15,\n \"payin_partner\": \"Checkout\",\n \"capture_id\": \"3456789OIUGFT787654RTYH\"\n}"}],"_postman_id":"fc4f966b-5616-41d9-a47b-7c3e9322742b"},{"name":"Refund an order","id":"3ce13a77-d161-46b6-a53b-dccd4a357d2d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"Private api key","type":"text"},{"key":"version","value":"1.0.0","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"amount","value":"","description":"Amount to be refunded. This amount can only be inferior or equal to the total_capture_amount
\n"},{"key":"refund_reason","value":"","description":"Reason for the refund : requested_by_customer, fraudulent, duplicate, other
\n","type":"text"}]},"url":"{{apiUrl}}/payment/maintenance/refund/{{order_id}}","description":"When you refund an order, you must specify its order_id.
\nCreating a new refund will refund an order that has previously been captured but not refunded yet. Funds will be refunded via the payment brand originally charged.
\nYou can optionally refund only part of an order. You can do so multiple times, until the order has been completely refunded.
\nOnce entirely refunded, an order can’t be refunded again. This method will return an error when called on an already-refunded order, or when trying to refund more money than is left on the order.
\nIf you're trying to refund an order with authorized status, then please refer to the cancel request.
\n","urlObject":{"path":["payment","maintenance","refund","{{order_id}}"],"host":["{{apiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"cf290615-a4db-4070-8b3d-e73408829856","name":"Refund successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"YOUR_PRIVATE_API_KEY","type":"text"},{"key":"version","value":"1.0.0","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\":1.15,\n \"refund_reason\":\"requested_by_customer\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.onramppay.com/payment/maintenance/refund/123456789"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"environment","value":"sandbox","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"code\": \"621080\",\n \"description\": \"pending refund request\"\n },\n \"order_id\": \"123456789\",\n \"transaction_id\": \"458UGH98765YGFGY7\",\n \"status\": \"refund_requested\",\n \"payment_method_name\": \"visa\",\n \"order_amount\": 1.15,\n \"order_currency\": \"EUR\",\n \"order_merchant_id\": \"0001111222\",\n \"is_authenticated\": false,\n \"is_authorized\": true,\n \"refund_date\": \"2022-06-21T13:38:33.070Z\",\n \"refund_request_status\": \"refund_requested\",\n \"refunded_amount\": 0,\n \"refundable_amount\": 0,\n \"total_refund_amount_requested\": 1.15,\n \"refund_amount_requested\": 1.15,\n \"payin_partner\": \"Checkout\",\n \"request_id\": \"45678UGU89765478UGY8765\"\n}"}],"_postman_id":"3ce13a77-d161-46b6-a53b-dccd4a357d2d"},{"name":"Refund an order with partial capture","id":"891a0cc0-18aa-48ed-9897-ca2f204f939a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"Private api key","type":"text"},{"key":"version","value":"1.0.0","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"amount","value":"","description":"Amount to be refunded. This amount can only be inferior or equal to the total_capture_amount
\n"},{"key":"refund_reason","value":"","description":"Reason for the refund : requested_by_customer, fraudulent, duplicate, other
\n","type":"text"},{"key":"capture_id","value":"","description":"Id of the capture you want to refund. Mandatory field if you have done a partial capture. You can find this information in the response of POST /maintenance/capture
\n","type":"text"}]},"url":"{{apiUrl}}/payment/maintenance/refund/{{order_id}}","description":"When you refund an order, you must specify its order_id.
\nCreating a new refund will refund an order that has previously been captured but not refunded yet. Funds will be refunded via the payment brand originally charged.
\nYou can optionally refund only part of an order. You can do so multiple times, until the order has been completely refunded.
\nIf you have capture the order only partially or trough several capture requests. You will need to specify the capture_id in the refund request.
\nOnce entirely refunded, an order can’t be refunded again. This method will return an error when called on an already-refunded order, or when trying to refund more money than is left on the order.
\nIf you're trying to refund an order with authorized status, then please refer to the cancel request.
\n","urlObject":{"path":["payment","maintenance","refund","{{order_id}}"],"host":["{{apiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"e52d9e1d-f838-4dc9-a61c-e6a17f1a2890","name":"Refund successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"YOUR_PRIVATE_API_KEY","type":"text"},{"key":"version","value":"1.0.0","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\":1.15,\n \"refund_reason\":\"requested_by_customer\",\n \"capture_id\":\"456789087654567898YTFGY7654\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.onramppay.com/payment/maintenance/refund/123456789"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"environment","value":"sandbox","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"code\": \"621080\",\n \"description\": \"pending refund request\"\n },\n \"order_id\": \"123456789\",\n \"transaction_id\": \"458UGH98765YGFGY7\",\n \"status\": \"refund_requested\",\n \"payment_method_name\": \"visa\",\n \"order_amount\": 1.15,\n \"order_currency\": \"EUR\",\n \"order_merchant_id\": \"0001111222\",\n \"is_authenticated\": false,\n \"is_authorized\": true,\n \"refund_date\": \"2022-06-21T13:38:33.070Z\",\n \"refund_request_status\": \"refund_requested\",\n \"refunded_amount\": 0,\n \"refundable_amount\": 0,\n \"total_refund_amount_requested\": 1.15,\n \"refund_amount_requested\": 1.15,\n \"payin_partner\": \"Checkout\",\n \"request_id\": \"45678UGU89765478UGY8765\"\n}"}],"_postman_id":"891a0cc0-18aa-48ed-9897-ca2f204f939a"},{"name":"Cancel an order","id":"62526ff5-2c21-422b-ad2b-7194b59803d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"Private api key","type":"text"},{"key":"version","value":"1.0.0","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"{{apiUrl}}/payment/maintenance/cancel/{{order_id}}","description":"Use the /cancel end-point to void a previous successful authorization.
\nThis operation will release the funds on hold on your customer account. This operation can only be done if no capture has been done yet.
\nAlso keep in mind that an authorization will expire on its own after a month but if you wish to release the authorization earlier, you can use this endpoint.
\nOnce the authorization has been succesfully cancelled, the order cannot be captured.
\nFind below the status workflow for this specific operation :
\n![](\"https://content.pstmn.io/dbb9e728-8b32-4220-8ef7-f04a3b6bbb0a/Y2FuY2VsLWF1dGhvcml6YXRpb24uanBn\")
","urlObject":{"path":["payment","maintenance","cancel","{{order_id}}"],"host":["{{apiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"d37e811b-7859-423f-8168-55bb52dbc2f8","name":"Cancel an order","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","type":"text"},{"key":"x-api-key","value":"YOUR_PRIVATE_API_KEY","type":"text"},{"key":"version","value":"1.0.0","type":"text"}],"url":"https://api-sandbox.onramppay.com/payment/maintenance/cancel/607ef8b3423a54000a8caba9"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{ \n \"result\": {\n \"code\": \"977777\",\n \"description\": \"Authorization Cancel requested\"\n },\n \"order_id\": \"123456789765\",\n \"transaction_id\": \"63e122f92c34b18c94c9b587\",\n \"status\": \"authorization_cancel_requested\",\n \"payment_method_name\": \"visa\",\n \"order_amount\": 123.42,\n \"order_currency\": \"EUR\",\n \"order_merchant_id\": \"ORD-3747465478-1\",\n \"cancellation_date\": null,\n \"cancellation_result\": \"pending\",\n \"request_id\": \"63e123002c34b18c94c9b5b2\"\n }\n "}],"_postman_id":"62526ff5-2c21-422b-ad2b-7194b59803d8"}],"id":"af1efc59-2739-4407-824e-d27fd4938c4f","description":"The /maintenance endpoint will cover all the operations that can happen post successful authorization.
\nIt can only be used after a successful authorization (through the /payment/order).
\n","_postman_id":"af1efc59-2739-4407-824e-d27fd4938c4f"},{"name":"3D Secure authentication","item":[{"name":"Create an order with 3DSecure","id":"387525d6-36b2-4eee-8345-c244a1819b4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"Private api key","type":"text"},{"key":"version","value":"1.0.0","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"operation_type","value":"","description":"(Required) Specify the kind of order you want to create: authorize or direct_capture
\n","type":"text"},{"key":"token","value":"","description":"(Required) Given in response to the `/payment/token' request
\n","type":"text"},{"key":"merchant_contract","value":"","description":"The merchant contract id used to process the transaction. You will find this information in your OnRamp account
\n","type":"text"},{"key":"checkout_id","value":"","description":"(Required) Specify the id of the checkout previously created.
\n","type":"text"},{"key":"payment_method_name","value":"","description":"The name of the method used by the customer to pay this order. Please refer to the APM folder
\n","type":"text"},{"key":"amount","value":"","description":"(Required) A positive number with 3 decimals digit max to describe the charge of the order
\n","type":"text"},{"key":"currency","value":"","description":"(Required) The 3-letter ISO currency code refering to the authorization currency
\n","type":"text"},{"key":"order_merchant_id","value":"","description":"(Required) Unique identifier used by the merchant for an order
\n","type":"text"},{"key":"payment_channel","value":"","description":"(Required) Describes where the transaction is taking place : e-commerce, moto, pos
\n","type":"text"},{"key":"website_url","value":"","description":"The website where the order was issued.
\n","type":"text"},{"key":"device_type","value":"","description":"The type of device used by the customer for this order: mobile, laptop, desktop, watch, smart_home, other
\n","type":"text"},{"key":"challenge_preference","value":"","description":"Selects the authentication scenario you want applied for this order : no_preference,challenge_mandatory,challenge_requested,no_challenge
\n","type":"text"},{"key":"dynamic_descriptor_authorization","value":"","description":"The description passed along on the customer bank statement. This option may not always be possible depending on the chosen route.
\n","type":"text"},{"key":"customer_id","value":"","description":"The unique identifier of the customer
\n","type":"text"},{"key":"customer_email","value":"","description":"The customer's e-mail address.
\n","type":"text"},{"key":"customer_first_name","value":"","description":"The customer's first name.
\n","type":"text"},{"key":"customer_last_name","value":"","description":"The customer's last name.
\n","type":"text"},{"key":"customer_identification_number","value":"","description":"The customer's identification number. Depending on the `payment_method, this field can be used to send an ID number or a fiscal number.
\n","type":"text"},{"key":"customer_gender","value":"","description":"The customer's gender: male, female, other
\n","type":"text"},{"key":"customer_street_name","value":"","description":"The customer's address.
\n","type":"text"},{"key":"customer_city","value":"","description":"The customer's city.
\n","type":"text"},{"key":"customer_zip_code","value":"","description":"The customer's zip code.
\n","type":"text"},{"key":"customer_country","value":"","description":"The customer's country. 2-letter ISO country code
\n","type":"text"},{"key":"customer_ip","value":"","description":"The customer's ip address.
\n","type":"text"},{"key":"customer_billing_first_name","value":"","description":"The billing customer first name.
\n","type":"text"},{"key":"customer_billing_last_name","value":"","description":"The billing customer last name.
\n","type":"text"},{"key":"customer_billing_street_name","value":"","description":"The billing customer address.
\n","type":"text"},{"key":"customer_billing_city","value":"","description":"The billing customer city.
\n","type":"text"},{"key":"customer_billing_zip_code","value":"","description":"The billing customer zip code.
\n","type":"text"},{"key":"customer_billing_country","value":"","description":"The billing customer country. 2-letter ISO country code
\n","type":"text"},{"key":"customer_birth_date","value":"","description":"The customer birth date.
\n","type":"text"},{"key":"customer_phone_number","value":"","description":"The customer phone number.
\n","type":"text"},{"key":"customer_phone_number_type","value":"","description":"The type of customer phone number : mobile, home, work
\n","type":"text"},{"key":"is_customer_registered","value":"","description":"Indicates if the customer has an account.
\n","type":"text"},{"key":"customer_account_creation_date","value":"","description":"The creation date of the customer's account.
\n","type":"text"},{"key":"customer_account_change_date","value":"","description":"The date of the last customer account's update
\n","type":"text"},{"key":"customer_account_change_password_date","value":"","description":"The date of the last customer account password's change
\n","type":"text"},{"key":"customer_account_attempts_order_day","value":"","description":"The number of order attempts (succesfull or failed) registered for this customer in the last 24 hours
\n","type":"text"},{"key":"customer_account_attempts_order_six_months","value":"","description":"The number of order attempts (succesfull or failed) registered for this customer in the last 6 months
\n","type":"text"},{"key":"customer_account_attempts_order_year","value":"","description":"The number of order attempts (succesfull or failed) registered for this customer in the last year
\n","type":"text"},{"key":"customer_account_add_payment_means_date","value":"","description":"The date of the payment method 's registration on the customer's account.
\n","type":"text"},{"key":"customer_account_successful_orders_day","value":"","description":"The number of successful order registered for this customer in the last 24 hours
\n","type":"text"},{"key":"customer_account_successful_orders_six_months","value":"","description":"The number of successful order registered for this customer in the last 6 months
\n","type":"text"},{"key":"customer_account_successful_orders_year","value":"","description":"The number of successful order registered for this customer in the last year.
\n","type":"text"},{"key":"customer_browser_info_accept_header","value":"","description":"The accept header value of the customer's browser.
\n","type":"text"},{"key":"customer_browser_info_color_depth","value":"","description":"The color depth of the customer's browser in bits per pixel.
\n","type":"text"},{"key":"customer_browser_info_java_enabled","value":"","description":"Indicates if the customer's browser is able to execute java.
\n","type":"text"},{"key":"customer_browser_info_js_enabled","value":"","description":"Indicates if the customer's browser is able to execute javascript
\n","type":"text"},{"key":"customer_browser_info_language","value":"","description":"The language of the customer's browser.
\n","type":"text"},{"key":"customer_browser_info_screen_height","value":"","description":"The height of the customer's browser.
\n","type":"text"},{"key":"customer_browser_info_screen_width","value":"","description":"The width of the customer's browser.
\n","type":"text"},{"key":"customer_browser_info_time_zone","value":"","description":"The time zone of the customer's browser.
\n","type":"text"},{"key":"customer_browser_info_user_agent","value":"","description":"The user agent of the customer's browser.
\n","type":"text"},{"key":"is_return_accepted","value":"","description":"Indicates if returns are accepted for this order.
\n","type":"text"},{"key":"basket_content","value":"","description":"Details of the basket item by item, please refer to the example to see all the fields available in the array. We strongly recommend that you either use this field or the 3 following ones : 'order_description, order_availabilityandorder_availability_date`. But not all at the same time.
\n","type":"text"},{"key":"customer_items_reorder","value":"","description":"Indicates if the customer has already ordered one of the items in the basket during the past year.
\n","type":"text"},{"key":"shipping_id","value":"","description":"Unique identifier of the shipping.
\n","type":"text"},{"key":"shipping_carrier_name","value":"","description":"Name of the carrier used for the shipping
\n","type":"text"},{"key":"shipping_delivery_range","value":"","description":"Estimated range of delivery. Possible values : sameday, lessthan2days, morethan2days
\n","type":"text"},{"key":"shipping_delivery_method","value":"","description":"Indicates where the order is being delivered.\nPossible values : customer_address, in_store, pickup_store, other
\n","type":"text"},{"key":"shipping_price","value":"","description":"Total price of the delivery.
\n","type":"text"},{"key":"shipping_tax","value":"","description":"Amount of tax included in the total shipping amount.
\n","type":"text"},{"key":"shipping_tax_rate","value":"","description":"Tax rate applied on the shipping.
\n","type":"text"},{"key":"shipping_first_name","value":"","description":"The shipping address first name.
\n","type":"text"},{"key":"shipping_last_name","value":"","description":"The shipping address last name.
\n","type":"text"},{"key":"shipping_phone_number","value":"","description":"The shipping address phone number
\n","type":"text"},{"key":"shipping_address_street_name_line1","value":"","description":"The shipping address street name (first line)
\n","type":"text"},{"key":"shipping_address_street_name_line2","value":"","description":"The shipping address street name (second line)
\n","type":"text"},{"key":"shipping_address_city","value":"","description":"The shipping address city.
\n","type":"text"},{"key":"shipping_address_zip_code","value":"","description":"The shipping address zip code.
\n","type":"text"},{"key":"shipping_address_country","value":"","description":"The shipping address country. 2-letter ISO country code
\n","type":"text"},{"key":"shipping_address_first_use_date","value":"","description":"The date when the shipping address was first used.
\n","type":"text"},{"key":"giftcard_used","value":"","description":"Indicates if a gift card was used.
\n","type":"text"},{"key":"giftcard_amount","value":"","description":"Total amount used on the gift(s) card.
\n","type":"text"},{"key":"giftcard_currency","value":"","description":"Currency of the gift(s) card. 3-letter ISO currency code
\n","type":"text"},{"key":"giftcard_number","value":"","description":"Number of gift cards used.
\n","type":"text"},{"key":"accept_url","value":"","description":"URL to redirect your customer to once the payment process is completed successfully.
\n","type":"text"},{"key":"decline_url","value":"","description":"URL to redirect your customer to after the payment is declined.
\n","type":"text"},{"key":"pending_url","value":"","description":"URL to redirect your customer to when the payment request was processed but response is not yet available
\n","type":"text"},{"key":"exception_url","value":"","description":"URL to redirect your customer to after a system failure.
\n","type":"text"}]},"url":"{{apiUrl}}/payment/order","description":"Use the authentication_indicator field to determine the scenario you want to be in.
\nWhen authentication_indicator=no_3ds, we will directly present the order in authorization. Here, we strongly advise you to use the sca_exemption_reason to explain why this transaction should not go through the authentication process.
\nAlso, be aware that you can still receive a redirect_url if the issuer considers that this attempt should go through the authentication process. So be sure to always expect it in the response.
\nWhen authentication_indicator=ask_3ds, we will do the authentication process if the card is enrolled, if not, we will go directly to the authorization process.
\nWhen authentication_indicator=force_3ds, we will go through the authentication process. If the 3DSecure is not successful after the check enrollment of the card, we will stop the process and decline the transaction.
\nFrictionless and challenge flow
\nWhat is a frictionless flow ?
\nA frictionless 3DSecure transaction happens when the authentication process is successfully done without having to redirect your customer towards its bank authentication page.
\nThis flow offers the best of both worlds: the security of the 3DSecure without the risk of losing your customer in the payment process.
\nHow to make it happen?
\nThe issuer will use all the data sent in the payment process to authenticate your customer without having to use a 2-factor-authentication process. So make sure to send as much data as you can. \nYou will see for instance fields about your customer's browser or its account history. The more data you are able to share about your customer, the more chance you have of having a frictionless flow.
\nWhat is the challenge flow?
\nThe challenge flow is similar to the flow you are used to with a 3DSecure 1 transaction.
\nBasically the issuer considers that it doesn't have enough information about the customer and its related transaction to be able to authenticate it by itself and asks the customer to authenticate.
\nFor you, as a merchant, you will receive a redirect_url in the response.
\nThe only difference with 3DSecure 1 is the way the customer will authenticate. Depending on the issuer, the customer might have to use Biometric or in-app authentication for instance, instead of the classical SMS OTP, which is already an improvement in terms of user experience.
\n","urlObject":{"path":["payment","order"],"host":["{{apiUrl}}"],"query":[],"variable":[]}},"response":[{"id":"534ff3a9-024b-445b-a530-7bd3a070b93b","name":"Create an order card with 3DSecure","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"{{apiKey}}","type":"text"},{"key":"version","value":"1.0.0","type":"text"}],"body":{"mode":"raw","raw":"{\n \"operation_type\": \"direct_capture\",\n \"token\": \"b65ab7f6099b1fd8e357ea319dc851f70daebe9e333be065a23d8239130089c3\",\n \"merchant_contract\": \"615f3246c67357000ad55863\",\n \"checkout_id\":\"67ceb40f9af8068910f8a819\",\n \"payment_method_name\": \"visa\",\n \"amount\": \"68.18\",\n \"currency\": \"EUR\",\n \"order_merchant_id\": \"276398531664\",\n \"payment_channel\": \"e-commerce\",\n \"website_url\": \"https://www.example.com/\",\n \"device_type\": \"mobile\",\n \"authentication_indicator\": \"ask_3ds\",\n \"dynamic_descriptor_authorization\": \"VITAMIX-276398531664\",\n \"customer_id\": \"4025251046660958\",\n \"customer_email\": \"kirby.nash@gmail.com\",\n \"customer_first_name\": \"Kirby\",\n \"customer_last_name\": \"Nash\",\n \"customer_identification_number\": \"GTF730340H7\",\n \"customer_gender\": \"female\",\n \"customer_street_name\": \"37 rue du Président Roosevelt\",\n \"customer_city\": \"SARTROUVILLE\",\n \"customer_zip_code\": \"78500\",\n \"customer_country\": \"FR\",\n \"customer_ip\": \"203.200.6.117\",\n \"customer_billing_first_name\": \"Kirby\",\n \"customer_billing_last_name\": \"Nash\",\n \"customer_billing_street_name\": \"37 rue du Président Roosevelt\",\n \"customer_billing_city\": \"SARTROUVILLE\",\n \"customer_billing_zip_code\": \"78500\",\n \"customer_billing_country\": \"FR\",\n \"customer_birth_date\": \"2020-06-22\",\n \"customer_phone_number\": \"0686606737\",\n \"customer_phone_number_type\": \"mobile\",\n \"is_customer_registered\": true,\n \"customer_account_creation_date\": \"2020-03-19\",\n \"customer_account_change_date\": \"2020-06-18\",\n \"customer_account_change_password_date\": \"2020-06-18\",\n \"customer_account_attempts_order_day\": \"1\",\n \"customer_account_attempts_order_six_months\": \"6\",\n \"customer_account_attempts_order_year\": \"8\",\n \"customer_account_successful_orders_day\": \"1\",\n \"customer_account_successful_orders_six_months\": \"5\",\n \"customer_account_successful_orders_year\": \"7\",\n \"customer_account_add_payment_means_date\": \"2020-06-18\",\n \"customer_browser_info_color_depth\": \"test1\",\n \"customer_browser_info_accept_header\": \"test2\",\n \"customer_browser_info_java_enabled\": true,\n \"customer_browser_info_js_enabled\": false,\n \"customer_browser_info_language\": \"FR\",\n \"customer_browser_info_screen_height\": 119,\n \"customer_browser_info_screen_width\": 333,\n \"customer_browser_info_time_zone\": \"+01:00\",\n \"customer_browser_info_user_agent\": \"Mozilla---\",\n \"is_return_accepted\": true,\n \"basket_id\": \"BSK-5942478750\",\n \"basket_content\": [\n {\n \"product_sku\": \"TSH-MED-WHI-COT\",\n \"product_id\": \"39851062\",\n \"product_name\": \"Tee Shirt MED\",\n \"product_description\": \"White tee shirt, size M\",\n \"product_price\": \"20.00\",\n \"product_quantity\": \"2\",\n \"product_availability\": true,\n \"product_type\": \"physical\",\n \"product_tax_amount\": \"4.14\",\n \"total_amount\": \"44.14\",\n \"seller_id\": \"SEL-07428099\",\n \"seller_name\": \"nounplus\",\n \"seller_commission\": \"4.41\"\n },\n {\n \"product_sku\": \"DRE-MED-RED-LEA\",\n \"product_id\": \"40547343\",\n \"product_name\": \"Dress MED\",\n \"product_description\": \"Red dress, size M\",\n \"product_price\": \"22\",\n \"product_quantity\": \"1\",\n \"product_availability\": true,\n \"product_type\": \"physical\",\n \"product_tax_amount\": \"2.04\",\n \"total_amount\": \"24.04\",\n \"seller_id\": \"SEL-54539757\",\n \"seller_name\": \"faruber\",\n \"seller_commission\": \"2.4\"\n }\n ],\n \"customer_items_reorder\": false,\n \"shipping_id\": \"318378289489\",\n \"shipping_carrier_name\": \"DHL\",\n \"shipping_delivery_range\": \"sameday\",\n \"shipping_delivery_method\": \"customer_address\",\n \"shipping_price\": 20,\n \"shipping_tax\": 5,\n \"shipping_first_name\": \"\",\n \"shipping_last_name\": \"\",\n \"shipping_phone_number\": \"\",\n \"shipping_address_street_name_line1\": \"16 rue de Raymond Poincaré\",\n \"shipping_address_street_name_line2\": null,\n \"shipping_address_city\": \"NEUILLY-SUR-SEINEs\",\n \"shipping_address_zip_code\": \"92200\",\n \"shipping_address_country\": \"FR\",\n \"shipping_address_first_use_date\": \"2020-03-19\",\n \"giftcard_used\": true,\n \"giftcard_amount\": 11,\n \"giftcard_number\": \"81467097\",\n \"giftcard_currency\": \"EUR\",\n \"max_attempts\": \"10\",\n \"accept_url\": \"https://www.google.com/search?q=accept\",\n \"decline_url\": \"https://www.google.com/search?q=decline\",\n \"pending_url\": \"https://www.google.com/search?q=pendind\",\n \"exception_url\": \"https://www.google.com/search?q=exception\"\n}","options":{"raw":{"language":"json"}}},"url":"{{apiUrl}}/order/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"environment","value":"{{environment}}","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"result\": {\n \"code\": \"421080\",\n \"description\": \"pending authorization\"\n },\n \"order_id\": \"60d1df940ddc65000a44dac4\",\n \"status\": \"authorization_requested\",\n \"payment_method_name\": \"visa\",\n \"order_amount\": 68.18,\n \"order_currency\": \"EUR\",\n \"order_merchant_id\": \"276398531664\",\n \"payment_channel\": \"e-commerce\",\n \"website_url\": \"www.norbr.com\",\n \"customer_id\": \"4025251046660958\",\n \"customer_email\": \"kirby.nash@gmail.com\",\n \"customer_first_name\": \"Kirby\",\n \"customer_last_name\": \"Nash\",\n \"customer_street_name\": \"37 rue du Président Roosevelt\",\n \"customer_city\": \"SARTROUVILLE\",\n \"customer_zip_code\": \"\",\n \"customer_country\": \"\",\n \"customer_ip\": \"127.0.0.1\",\n \"order_description\": \"\",\n \"is_suspicious\": false,\n \"risk_assessment_partner\": \"Checkout\",\n \"risk_assessment_date\": \"2021-06-22T13:03:27.689Z\",\n \"risk_assessment_result\": \"\",\n \"risk_assessment_reason\": \"\",\n \"risk_assessment_reason_code\": \"\",\n \"is_authenticated\": false,\n \"authentication_indicator\": \"ask_3ds\",\n \"authentication_partner\": \"Checkout\",\n \"authentication_date\": null,\n \"authentication_result\": \"\",\n \"authorization_date\": \"2021-06-22T13:03:16.856Z\",\n \"authorization_result\": \"created\",\n \"authorization_code\": \"pay_67r66as4ddd2xfipbsztiprqi4\",\n \"authorization_amount\": 68.18,\n \"is_captured\": false,\n \"capture_date\": null,\n \"capture_result\": \"\",\n \"capture_total_amount\": \"\",\n \"is_refunded\": false,\n \"refund_date\": null,\n \"refund_result\": \"\",\n \"refund_total_amount\": \"\",\n \"is_cancelled\": false,\n \"cancellation_date\": null,\n \"cancellation_result\": \"\",\n \"payin_partner\": \"Checkout\",\n \"merchant_contract_id\": \"608526227b9daa000b8c0174\",\n \"psp_result_code\": \"\",\n \"psp_result_description\": \"\",\n \"redirect_url\": \"https://3ds2-sandbox.ckotech.co/interceptor/3ds_qs65u3ln2sie7agr32zjkerifq\"\n}"}],"_postman_id":"387525d6-36b2-4eee-8345-c244a1819b4d"},{"name":"Create an order with exemption request","id":"226b522a-f612-41d8-b26b-f4d86871871d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"Private api key","type":"text"},{"key":"version","value":"1.0.0","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"operation_type","value":"","description":"(Required) Specify the kind of order you want to create: authorize or direct_capture
\n","type":"text"},{"key":"token","value":"","description":"(Required) Given in response to the /payment/token request
\n","type":"text"},{"key":"checkout_id","value":"","description":"(Required) Specify the id of the checkout previously created.
\n","type":"text"},{"key":"merchant_contract","value":"","description":"The merchant contract id used to process the transaction. You will find this information in your OnRamp account
\n","type":"text"},{"key":"payment_method_name","value":"","description":"The name of the method used by the customer to pay this order. Please refer to the APM folder
\n","type":"text"},{"key":"amount","value":"","description":"(Required) A positive number with 3 decimals digit max to describe the charge of the order
\n","type":"text"},{"key":"currency","value":"","description":"(Required) The 3-letter ISO currency code refering to the authorization currency
\n","type":"text"},{"key":"order_merchant_id","value":"","description":"(Required) Unique identifier used by the merchant for an order
\n","type":"text"},{"key":"payment_channel","value":"","description":"(Required) Describes where the transaction is taking place: e-commerce, moto, pos
\n","type":"text"},{"key":"website_url","value":"","description":"The website where the order was issued.
\n","type":"text"},{"key":"device_type","value":"","description":"The type of device used by the customer for this order : mobile, laptop, desktop, watch, smart_home, other
\n","type":"text"},{"key":"authentication_indicator","value":"","description":"Selects the authentication scenario you want applied for this order : no_3ds, ask_3ds, `force_3ds
\n","type":"text"},{"key":"customer_id","value":"","description":"The unique identifier of the customer.
\n","type":"text"},{"key":"customer_email","value":"","description":"The customer's e-mail address.
\n","type":"text"},{"key":"customer_first_name","value":"","description":"The customer's first name.
\n","type":"text"},{"key":"customer_last_name","value":"","description":"The customer's last name.
\n","type":"text"},{"key":"customer_identification_number","value":"","description":"The customer's identification number. Depending on the payment method, this field can be used to send an ID number or a fiscal number.
\n","type":"text"},{"key":"customer_gender","value":"","description":"The customer's gender : male, female, other
\n","type":"text"},{"key":"customer_street_name","value":"","description":"The customer's address.
\n","type":"text"},{"key":"customer_city","value":"","description":"The customer's city.
\n","type":"text"},{"key":"customer_zip_code","value":"","description":"The customer's zip code.
\n","type":"text"},{"key":"customer_country","value":"","description":"The customer's country.
\n","type":"text"},{"key":"customer_ip","value":"","description":"The customer's ip address.
\n","type":"text"},{"key":"customer_billing_first_name","value":"","description":"The billing customer first name.
\n","type":"text"},{"key":"customer_billing_last_name","value":"","description":"The billing customer last name.
\n","type":"text"},{"key":"customer_billing_street_name","value":"","description":"The billing customer address.
\n","type":"text"},{"key":"customer_billing_city","value":"","description":"The billing customer city.
\n","type":"text"},{"key":"customer_billing_zip_code","value":"","description":"The billing customer zip code.
\n","type":"text"},{"key":"customer_billing_country","value":"","description":"The billing customer country. 2-letter ISO country code
\n","type":"text"},{"key":"customer_birth_date","value":"","description":"The customer birth date.
\n","type":"text"},{"key":"customer_phone_number","value":"","description":"The customer phone number.
\n","type":"text"},{"key":"customer_phone_number_type","value":"","description":"The customer type of phone number : mobile, home, work
\n","type":"text"},{"key":"is_customer_registered","value":"","description":"Indicates if the customer has an account.
\n","type":"text"},{"key":"customer_account_creation_date","value":"","description":"The creation date of the customer's account.
\n","type":"text"},{"key":"customer_account_change_date","value":"","description":"The date of the last update of the customer's account.
\n","type":"text"},{"key":"customer_account_change_password_date","value":"","description":" ![\"\"](\"https://developer-static.norbr.io/Visa-small-logo.png\"){kind=logo}
![\"\"](\"https://developer-static.norbr.io/mc-small-logo.png\"){kind=logo}
![\"\"](\"https://developer-static.norbr.io/amex-small-logo.png\"){kind=logo}
![\"\"](\"https://developer-static.norbr.io/diners-small-logo.png\"){kind=logo}
![\"\"](\"https://developer-static.norbr.io/discover-small-logo.png\"){kind=logo}
![\"\"](\"https://developer-static.norbr.io/jcb-small-logo.png\"){kind=logo}