Payments

Payments Service Description

Creates a payment initiation request at the ASPSP and gets information about payments

API Profile

Attribute

Value

Name Payments
Version V1
Synopsis Payments
Description Creates a payment initiation request at the ASPSP and gets information about payments.
Pre-Conditions HTTP GET and POST method is allowed.
Authentication OAuth 2.0 with Client Credentials

Before your application can access the API, it must obtain a new an access token for each request. The access token can be used only one time.

Endpoint Definition

Account API’s development live and mock environments routing data

EndPoint / DEVELOPMENT SANDBOX SERVICE

URI /payments/v1
Base URL https://apis.garantibbva.ro:443


Technology

Technology Stack / DESIGN TIME

Property Value
HTTP Call Method GET,POST
Response Content Type application/json; charset=utf-8

Before your application can access the API, it must obtain a new an access token for each request. The access token can be used only one time.


APIS


Creates a payment initiation request at the ASPSP.


Path Parameters

Attribute

Type

Description

payment-product String The addressed payment product endpoint. The list of products supported is: - domestic-credit-transfers - sepa-credit-transfers - cross-border-credit-transfers

Request Header

Attribute

Type

Condition

Description

Content-Type String Mandatory application/json
X-Request-ID UUID Mandatory ID of the request, unique to the call, as determined by the initiating party. This is the unique ID of TPP for the payment initiation regarding PSD2 article 46b, 47 and EBA RTS article 29.
Intent-ID String Mandatory For establishing a new payment initiation, Intent ID generated in previous step (see Authentication page) should be sent.
PSU-IP-Address String Mandatory The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. If not available, the TPP shall use the IP Address used by the TPP when submitting this request.
TPP-Redirect-URI String Mandatory URI of the TPP, where the transaction flow shall be redirected to after a Redirect. Mandatory for response link scaOAuth field.
Client-ID String Mandatory TPP's Client ID, returned from Dynamic Registration.
Client-Secret String Mandatory TPP's Client Secret, returned from Dynamic Registration.
apikey String Mandatory API Key value obtained from Dashboard/Applications page in API Store, for SANDBOX/PRODUCTION plan.

Request Body

Data Element

Type

SCT EU Core

Cross Border CT Core

Domestic Credit Transfers

Description

endToEndIdentification Max35Text Optional NA Optional  
debtorAccount(incl.type) Account Reference Mandatory Mandatory Mandatory  
instructedAmount(inc. Curr.) Amount Mandatory Mandatory Mandatory  
transactionCurrency Currency Code NA NA NA This is a data element to indicate a diverging interbank currency
creditorAccount Account Reference Mandatory Mandatory Mandatory  
creditorAgent BICFI Optional Optional Optional  
creditorName Max70Text Mandatory Mandatory Mandatory  
creditorAddress Address Optional Optional Optional  
TaxId Max13Char NA NA Optional  
PriorityFlag NORM/HIGH/INST Optional Optional Optional  
remittance Information Unstructured Max140Text Optional Optional Optional  

Response Header

Attribute

Type

Condition

Description

Location String Mandatory Location of the created resource (if created)
X-Request-ID UUID Mandatory ID of the request, unique to the call, as determined by the initiating party.
ASPSP-SCA-Approach String Mandatory REDIRECT

Response Body

Attribute

Type

Condition

Description

transactionStatus Transaction Status Mandatory  
paymentId UUID Mandatory resource identification of the generated payment initiation resource.
_links Links Mandatory A list of hyperlinks to be recognised by the TPP. Type of links admitted in this response; "scaOAuth": The link which must be used for PSU login. After login is completed, PSU will be redirected to next stage, transaction signing. "self": The link to the Single Payment Initiation resource created by this request. This link can be used to retrieve the resource data. "status": The link to retrieve the transaction status of the payment initiation.


Sample Request


		
{ "instructedAmount": {"currency": "EUR", "amount": "123.50"}, "debtorAccount": {"iban": "DE40100100103307118608"}, "creditorName": "Merchant123", "creditorAccount": {"iban": "DE02100100109307118603"}, "remittanceInformationUnstructured": "Ref Number Merchant" }

 


Sample Response


		
{ "paymentId": "1f62583c-fb24-47be-808a-fec184d8d433", "transactionStatus": "RCVD", "_links": {"scaOAuth": {"href": "https://sso.garantibbva.ro/mga/sps/oauth/oauth20/authorize?response_type=code&client_id=jf9uzXRwWOnBkUc48Ax5&scope=openid&redirect_uri=https://www.TPPurl.com&id=1f62583c-fb24-47be-808a-fec184d8d433&type=p"}, "self": {"href": "/payments/v1/1f62583c-fb24-47be-808a-fec184d8d433"}, "status": {"href": "/payments/v1/1f62583c-fb24-47be-808a-fec184d8d433/status" }

 

Check the status of a payment initiation.

Path Parameters

Attribute

Type

Description

paymentId UUID Resource Identification of the related payment.

Request Header

Attribute

Type

Condition

Description

X-Request-ID UUID Mandatory ID of the request, unique to the call, as determined by the initiating party.
Authorization String Conditional Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the current PIS transaction or in a preceding AIS service in the same session, if no such OAuth2 SCA approach was chosen in the current PIS transaction.
Client-ID String Mandatory TPP's Client ID, returned from Dynamic Registration.
Client-Secret String Mandatory TPP's Client Secret, returned from Dynamic Registration.
apikey String Mandatory API Key value obtained from Dashboard/Applications page in API Store, for SANDBOX/PRODUCTION plan.

Response Header

Attribute

Type

Condition

Description

X-Request-ID UUID Mandatory ID of the request, unique to the call, as determined by the initiating party.

Response Body

Attribute

Type

Condition

Description

transactionStatus Transaction Status Mandatory In case where the Payment Initiation Request was JSON encoded as defined in Section 5.3.1, the status is returned in this JSON based encoding.


Sample Response


		
{ "transactionStatus": "ACCP" }

 

Returns the content of a payment object.

Path Parameters

Attribute

Type

Description

paymentId UUID ID of the corresponding payment initiation object as returned by an Payment Initiation Request

Request Header

Attribute

Type

Condition

Description

X-Request-ID UUID Mandatory ID of the request, unique to the call, as determined by the initiating party.
Authorization String Conditional Is contained only, if an OAuth2 based authentication was performed in a pre-step or an OAuth2 based SCA was performed in the current PIS transaction or in a preceding AIS service in the same session, if no such OAuth2 SCA approach was chosen in the current PIS transaction.
Client-ID String Mandatory TPP's Client ID, returned from Dynamic Registration.
Client-Secret String Mandatory TPP's Client Secret, returned from Dynamic Registration.
apikey String Mandatory API Key value obtained from Dashboard/Applications page in API Store, for SANDBOX/PRODUCTION plan.

Response Header

Attribute

Type

Condition

Description

X-Request-ID UUID Mandatory ID of the request, unique to the call, as determined by the initiating party.


Sample Response


		
{ "endToEndIdentification": "END TO END IDENTIFICATION", "debtorAccount": {"iban": "RO88UGBI0000012054879RON"}, "instructedAmount": {"currency": "RON", "amount": "77.0"}, "transactionCurrency": "RON", "creditorAccount": {"iban": "RO82UGBITVA0012053056RON"}, "creditorAgent": "BICCODE", "creditorName": "CREDITOR NAME", "remittanceInfoUnstructured": "REF NUMBER MERCHANT", "taxId": "12345", "priorityFlag": "NORM", "transactionFees": {"currency": "RON", "amount": "1.0"}, "transactionFeeIndicator": true, "creditorAddress": {"street":"Str.", "postalCode":"Postal", "country":"RO", "buildingNumber":"12", "city":"City"}, "paymentProductCode": "DOCT" }

 


	


Types


Account Reference

Attribute

Type

Condition

Description

iban IBAN Conditional  

Amount

Attribute

Type

Condition

Description

currency Currency Code Mandatory ISO 4217 Alpha 3 currency code
amount String Mandatory The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. Example: Valid representations for EUR with up to two decimals are: * 1056 * 5768.2 * -1.50 * 5877.78

Address

Attribute

Type

Condition

Description

street Max70Text Optional  
buildingNumber String Optional  
city String Optional  
postalCode String Optional  
country CountryCode Mandatory  

Transaction Status

Code

Name

ISO 20022 Definition

ACCP AcceptedCustomerProfile Preceding check of technical validation was successful. Customer profile check was also successful.
ACSC AcceptedSettlementCompleted Settlement on the debtor’s account has been completed. Usage: this can be used by the first agent to report to the debtor that the transaction has been completed. Warning: this status is provided for transaction status reasons, not for financial information. It can only be used after bilateral agreement
ACSP AcceptedSettlementInProcess All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution.
ACTC AcceptedTechnicalValidation Authentication and syntactical and semantical validation are successful
ACWC AcceptedWithChange Instruction is accepted but a change will be made, such as date or remittance not sent.
ACWP AcceptedWithoutPosting Payment instruction included in the credit transfer is accepted without being posted to the creditor customer’s account.
RCVD Received Payment initiation has been received by the receiving agent.
PDNG Pending Payment initiation or individual transaction included in the payment initiation is pending. Further checks and status update will be performed.
RJCT Rejected Payment initiation or individual transaction included in the payment initiation has been rejected.
CANC Cancelled Payment initiation has been cancelled before execution Remark: Change Request to ISO20022 is still needed.


Response Codes 

 

Code

Description

Type

200 OK ACCEPTED SUCCESS
201 OK RESOURCE CREATED
405 {http.method} Method Not Allowed CALL METHOD ERROR
400 Bad Request MISSING PARAMETERS
401 Invalid Credentials UNAUTHORIZED
404 Not Found NOT FOUND
500 Internal Server Error SYSTEM ERROR