Initiate a transaction
Processes a transaction with a card from the vault, without your customer. Use it to continue a recurring series from another platform: create the order with recurring_type set to recurring and the first_network_transaction_id, store the card, then initiate the transaction.
apiKeyAuthorizationBasic <token>Use your project's API key as the username and leave the password empty. Only use the API key from your server: it gives full access to your project.
order_id*stringThe id of the order.
uuidtransaction_id*stringThe id of the transaction, from the transactions of the order.
uuidapplication/json- body
vault_token*stringThe vault_token from the vault.
uuidThe transaction has been processed. The response contains the order.
application/json- response
id?stringOrder ID.
uuidproject_id?stringID of the project the order belongs to.
uuidmerchant_id?stringID of your merchant account.
uuidmerchant_order_id?stringYour own order reference. Recommended.
merchant_name?stringYour merchant name. Can be used for payouts, if configured.
description?stringDescription of the order. Recommended.
currency*CurrencyISO 4217 currency code, such as EUR, GBP or USD. Get supported currencies lists the currencies of your project.
^[A-Z]{3}$amount*AmountAmount in the smallest currency unit, including VAT. 1234 is € 12.34. For currencies without minor units, send the whole amount.
0 <= valuestatus?stringStatus of the order. completed, cancelled, expired and error are final. With see-transactions, the transactions have different statuses: check each of them. See Order statuses.
"new""processing""completed""cancelled""expired""error""see-transactions"flags?array<string>Labels of the order, such as is-test for orders in a test project and is-refund for refund orders.
created?TimestampDate and time in ISO 8601 format.
date-timemodified?TimestampDate and time in ISO 8601 format.
date-timecompleted?TimestampDate and time in ISO 8601 format.
date-timeexpiration_period?DurationHow long the order stays valid, such as PT1H for one hour.
payment_methods?array<>The payment methods to show on the hosted payment page. Without it, every payment method that's active in your project is shown.
transactions?array<>The payment attempts of the order. When you create the order, send one transaction to pick the payment method yourself. Without it, your customer picks a payment method on the hosted payment page.
order_url?stringThe hosted payment page of the order. Redirect your customer here when you didn't send a transaction.
urireturn_url?stringWhere your customer goes after the payment. Recommended.
urifailure_url?stringWhere your customer goes when the payment fails, with status cancelled, expired or error. Without it, your customer goes to the return_url.
uriwebhook_url?stringWhere webhooks for this order are sent. Overrides the webhook URL of your project.
uricustomer?Your customer. Card schemes use these details for 3-D Secure risk assessment, so complete details lead to more frictionless payments. Your acquirer can require some of them.
client?The software that sends the request, such as your e-commerce platform or plugin.
extra?Your own data to store with the order. It's returned when you retrieve the order.
refunded_amount?integerThe amount refunded on this order so far, in the smallest currency unit.
refund_of_order_id?stringFor a refund order, the ID of the original order.
uuidrefund_orders?array<>IDs of the refund orders of this order.
capture_of_order_id?stringFor a capture order, the ID of the original order.
uuidvoid_of_order_id?stringFor a void order, the ID of the original order.
uuidchargeback_of_order_id?stringFor a chargeback order, the ID of the original order.
uuidchargeback_orders?array<>IDs of the chargeback orders of this order.
reversal_of_order_id?stringFor a reversal order, the ID of the original order.
uuidreversal_orders?array<>IDs of the reversal orders of this order.
related_order_id?stringID of the original order, for any order created from another one.
uuidrelated_orders?array<>IDs of the orders created from this order.
related_payment_link_id?stringID of the payment link the order was created from.
uuidcurl -X POST 'https://api.dev.gingerpayments.com/v1/orders/8078d78f-8700-4cfe-94b1-4a777d3400f2/transactions/a5dac3de-d304-4570-922b-373d478b8b3a/initiate/' \ -H 'Content-Type: application/json' \ -d '{ "vault_token": "ab39817c-7e19-497a-ac7b-23526473b3c1"}'{ "id": "0a73c8e3-7a2f-40ee-8f6c-fa41a37c140a", "amount": 4000, "currency": "EUR", "merchant_order_id": "MIGRATED-SUB-001", "status": "processing", "transactions": [ { "id": "7e5d1b90-2c4a-4f83-b6d1-9a0e3c5f8b27", "amount": 4000, "currency": "EUR", "payment_method": "credit-card", "payment_method_brand": "visa", "payment_method_details": { "approval_code": "08C405", "authorization_iso_response_code": "00", "first_network_transaction_id": "MDSIZQ7RH0128", "network_transaction_id": "MDSIRCRRH0128", "recurring_type": "recurring", "schedule_type": "unscheduled", "vault_token": "ab39817c-7e19-497a-ac7b-23526473b3c1" }, "status": "accepted" } ]}