Advance Payment

The API endpoint to make an advance payment is POST /Smart/Transactions/STX_xxx/start/prepaid. There is no prior authorisation needed.

Request
POST /api/v2/Smart/Transactions/STX_xxx/start/prepaid HTTP/1.1
Host: connect-testing.secupay-ag.de
Authorization: Bearer qb56tjj1bcvo9n2nj4u38k84lo
Accept: application/json

If everything is fine, the API responds with 200 OK and the Smart Transaction:

Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"object": "smart.transactions",
"id": "STX_33PXAW2YN2NJTPM5KPGMK7QF5PBVA2",
// ...
"transactions": [
{
"object": "payment.transactions",
"id": "PCI_FDBREW9ZS7P6FTN4ZY2ATC6NK0QWO7",
// ...
}
],
"created": "2020-03-27T10:55:23+01:00",
"status": "pending",
// ...
"payment_method": "prepaid",
"payment_instructions": {
"owner": "secupay AG",
"iban": "DE81850400611005523759",
"bic": "COBADEFFXXX",
"bankname": "Commerzbank CC",
"purpose": "TA 49425099",
"girocode_url": "https://connect-testing.secupay-ag.de/qr/epc?stx=STX_33PXAW2YN2NJTPM5KPGMK7QF5PBVA2"
},
"trans_id": 49425099,
// ...
}

The Smart Transaction will change to status pending to signalise that we still wait for the payment. When the payment has arrived, it switches to ok (intent sale), and you can deliver.

Response parameters:

Field

Type

Meaning

transactions

array

The Payment Transactions and Loyalty Transactions created for this Smart Transaction.

status

string

Status ok means you can deliver. Status pending means you have to wait for ok. Status failed means the payment failed, and you must repeat the payment process.

payment_instructions

object

The payment instructions to be given to the payer.

Details of payment_instructions:

Field

Type

Meaning

owner

string

Account owner

iban

string

International Bank Account Number (IBAN)

bic

string

Bank Identifier Code (BIC)

bankname

string

Bank name

purpose

string

Purpose line

girocode_url

string

Image URL of an Girocode (EPC QR code) for the banking app.