API
Skip to main content

ATM Payment

To initiate an ATM payment, you only need to generate a 9-digit reference and provide it to the customer.

The process works as follows:

  1. Generate ATM reference;
  2. The user pays the reference at the ATM/online banking;
  3. SIBS communicates the confirmation to PayPay;
  4. PayPay notifies the payment status;

The following flow illustrates how ATM payment works:

MB flow

1. Generate ATM reference​

POST /payments/references
{
	"type": "payment",
	"amount": 100,
	"callbackUrl": "https://teste.pt", // Opcional se usar webhooks
	"availableMethods": [
		{
			"code": "MB"
		}
	],
	"validDate": {
		"start": "2022-04-01T14:45:56+00:00",
		"end": "2022-04-30T23:59:59+01:00"
	}
}

2. The user pays the reference​

If a callback URL or webhook is specified, a notification will be sent.

3. Check the payment status​

GET ​/payments/{id}
{
	"apiVersion": "1.4.0",
	"date": "2022-03-09T14:45:56+00:00",
	"success": true,
	"data": {
		"id": "50438",
		"type": "payment",
		"referenceDetails": {
			"entity": "12797",
			"reference": "002492617"
		},
		"stateDetails": {
			"state": "confirmed",
			"createdAt": "2021-10-07T18:07:46+01:00"
		},
		"amount": 100,
		"createdAt": "2022-03-09T14:45:56+00:00",
		"updatedAt": "2022-03-09T14:45:56+00:00",
		"validDate": {
			"start": "2022-04-01T14:45:56+00:00",
			"end": "2022-04-30T23:59:59+01:00"
		},
		"availableMethods": [
			{
				"code": "MB",
				"type": "REALTIME",
				"name": "Multibanco"
			}
		]
	}
}