SAP Digital Payments - Get payment card registration URL
Get URL of payment card registration UI from payment service provider.
URL
/cnbs/v1/dp/reg_url
Method
POST
Parameters
Required
- Payer (payer_data)
- Customer Number (customer_number)
- Company Code (company_code)
- Redirect URL (redirect_url)
- Session Card (session_card)
- true … add card as session card
- false … add card to customer master account
- Digital Payment Method (dp_payment_method)
- CC … Credit Card
- EP … External Payment
Optional for PSP tokenization
- PSP Payment Type (dp_payment_type)
- CC … Credit Card
- EC … eCheck
- TO … Existing token
- PSP Tokenization details (tds)
- Integration (pmint)
- I = iFrame
- H = Hosted
- Host URL (host_url)
- CSS URL (css_url)
- Card Indicator (card_indicator)
- X = Generate HTML with Paymetric Card Indicator
- Payment details (pm)
- Redirect URL (redirect_uri)
- the URI used to redirect back to the UI after 3DS processing
- Amount (amount)
- without any decimalization (e.g. 1.00 USD must be entered as 100)
- Currency Code ISO 4217 (currency_code)
- e.g. USD = 840
- Billing Address 1 (billing_address1)
- Billing City (billing_city)
- Billing Postal Code (billing_postal_code)
- Billing Country ISO 3166-1 Code (billing_country_code)
- e.g. US = 840
- Billing State (billing_state)
- Billing Phone (billing_phone)
- Billing First Name (billing_first_name)
- Billing Last Name (billing_last_name)
- Billing email (billing_email)
- Mobile Phone No (mobile_phone)
- Order Number (order_number)
- Shipping Address 1 (shipping_address1)
- Shipping City (shipping_city)
- Shipping Postal Code (shipping_postal_code)
- Shipping Country Code (shipping_country_code)
- Shipping State (shipping_state)
- Work Phone No (work_phone)
- 3DS Version (threeds_version)
- Payment Card Token (payment_card_token)
Sample Implementation
Response
- Registration URL (registration_url)
- Session ID (session_id)
- The session ID will be needed to get the payment card data
- Payment Service Provider (psp)
- Status (status)
- Message Type (message_type)
- SAP Message Type.
- Errors:
- E = Error
- A = Abort
- X = Exception
- Others:
- S = Success
- W = Warning
- I = Information
- Message Identifier (message_identification)
- SAP Message ID.
- Message Number (message_number)
- SAP Message Number.
- Message Line (message_line_string)
- SAP Message Text.
Example Response
{
"registration_url": "https://sandbox.payfabric.com/payment/web/wallet/create?customer=19b2b8020aea99a125a16884e0dac0ba16ebca7b9ce&tender=CreditCard&token=2:4us00lbgckfo&MultipleTender=true&ReturnURI=https://epay-s4dev.cnbssoftware.com/",
"session_id": "19b2c8ef4892209acecb362422abd9a030a5ef54b5",
"psp": "PFEP",
"status": {
"message_type": "S",
"message_identification": "/CNBS/X_API",
"message_number": 10,
"message_line_string": "Request successfully processed"
}
}