v1

latestOpenAPI 3.0.02026-07-24440173.4 KB

Payments (V2)

GetPaymentStatus

Checks the status of an invoice to verify whether the payment has been completed successfully. This endpoint allows you to inquire about payment status using InvoiceId, PaymentId, or CustomerReference.

post/v2/GetPaymentStatus

Request body

Keystring required

Refers to the invoice number or paymentId based on the key type.

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

InvoiceId: Refers to the invoice number generated by MyFatoorah. 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 retrieved successfully

IsSuccessboolean

Indicates if the request was successful.

Messagestring

Response message associated with the request.