Sign in

v1

latestOpenAPI 3.0.02026-07-24440173.4 KB
Payments (V2)

UpdatePaymentStatus

Updates the payment status by either capturing fully/partially the invoice amount or releasing the amount back into the customer's account. This endpoint is used for authorization and capture operations. Note: You can make only one Capture/Release operation on each invoice.

post/v2/UpdatePaymentStatus

Request body

Operation'Capture' | 'Release' required

Capture: Refers to capturing fully or partially the invoice value. Release: Refers to releasing fully the invoice value to the customer's account.

Amountnumber

The amount to be captured/released. For Capture: The amount has to be less than or equal to the invoice value (Mandatory). For Release: The amount has to be equal to the invoice value (Optional).

Keystring required

Refers to the Invoice ID, payment ID, or Customer Reference based on the key type.

KeyType'InvoiceId' | 'PaymentId' | 'CustomerReference' required

InvoiceId: Refers to the invoice number that MyFatoorah generates. PaymentId: The value returned upon having any update on the invoice payment (recommended). CustomerReference: The reference used to link your orders in the store.

Response

Payment status updated successfully

IsSuccessboolean

Indicates if the request was successful.

Messagestring

Response message associated with the request.