Initiate Payment

The data about the payment are in the body request:

instructedAmount – amount and currency
debtorAccount – payer’s IBAN
creditorAccount – recipient’s IBAN
creditorName – recipient’s name

The other fields are optional.
A unique ID is generated for the payment, and upon successful creation of a payment request, links for further operations are returned in the response – payment information (self), payment status (status), and authorization operations (authoriseTransaction).

End-point URL #

http://[ip]:[port]/psd2/v1/payments/domestic-credit-transfers-bgn

Method: POST 

Headers #
  • X-Request-ID: [request-id] – Required: A unique request ID (GUID).
  • Content-Type: application/json – Required: Specifies the request format.
  • PSU-ID: [user-id] – Required: User identifier obtained upon login.
Request Body #

{
	"instructedAmount": {
		"currency": "USD",
		"amount": "123.50"
	},
	"debtorAccount": {
		"iban": "BG53TEPJ40131001000119"
	},
	"creditorName": "IhuAhu.com",
	"creditorAccount": {
		"iban": "TR73TURKBANK123456789"
	},
	"paymentType": {
		"serviceLevel": "SS1"
	},
	"remittanceInformationUnstructured": "ihuahu link"
}

Response #

{
	"transactionStatus": "RCVD",
	"paymentId": "526091c1-e4ac-410a-a642-65af191ee8a9",
	"_links": {
		"self": {
			"href": "/v1/payments/bgn-credit-transfer/526091c1-e4ac-410a-a642-65af191ee8a9"
		},
		"status": {
			"href": "/v1/payments/bgn-credit-transfer/526091c1-e4ac-410a-a642-65af191ee8a9/status"
		},
		"authoriseTransaction": {
			"href": "/v1/payments/bgn-credit-transfer/526091c1-e4ac-410a-a642-65af191ee8a9/authorisations"
		}
	}
}

Remarks #

The transactionStatus field indicates the current status of the payment request.
The paymentId uniquely identifies this payment request.
Links (_links) are provided for accessing the payment details (self), checking payment status (status), and authorizing the transaction (authoriseTransaction).

Snippet #

API Properties
Header parameters
Result of the call

Powered by BetterDocs