com.mangopay.core.APIs

Interface UboDeclarationApi

All Known Implementing Classes:

UboDeclarationApiImpl

public interface UboDeclarationApi

Class handling API methods concerning the UBO declaration entity.

Method Summary

Modifier and Type	Method and Description
UboDeclaration	create(java.lang.String userId) Creates a new UBO Declaration for an user.
Ubo	createUbo(java.lang.String userId, java.lang.String uboDeclarationId, Ubo ubo)
UboDeclaration	get(java.lang.String uboDeclarationId)
UboDeclaration	get(java.lang.String userId, java.lang.String uboDeclarationId) Gets an UBO Declaration
java.util.List<UboDeclaration>	getAll(java.lang.String userId, Pagination pagination, Sorting sort)
Ubo	getUbo(java.lang.String userId, java.lang.String uboDeclarationId, java.lang.String uboId)
UboDeclaration	submitForValidation(java.lang.String userId, java.lang.String uboDeclarationId) Updates an UBO Declaration with the status VALIDATION_ASKED.
Ubo	updateUbo(java.lang.String userId, java.lang.String uboDeclarationId, Ubo ubo)

Method Detail

create

UboDeclaration create(java.lang.String userId)
               throws java.lang.Exception

Creates a new UBO Declaration for an user.

Parameters:

userId - ID of the user

Returns:

UboDeclaration instance from the API

Throws:

java.lang.Exception

getAll

java.util.List<UboDeclaration> getAll(java.lang.String userId,
                                      Pagination pagination,
                                      Sorting sort)
                               throws java.lang.Exception

Throws:

java.lang.Exception

get

UboDeclaration get(java.lang.String userId,
                   java.lang.String uboDeclarationId)
            throws java.lang.Exception

Gets an UBO Declaration

Parameters:

userId - ID of the user

uboDeclarationId - ID of the UboDeclaration

Returns:

UboDeclaration object

Throws:

java.lang.Exception

createUbo

Ubo createUbo(java.lang.String userId,
              java.lang.String uboDeclarationId,
              Ubo ubo)
       throws java.lang.Exception

Parameters:

userId - ID of the user

ubo - Ubo

uboDeclarationId - ID of the UboDeclaration

Returns:

Ubo object

Throws:

java.lang.Exception

updateUbo

Ubo updateUbo(java.lang.String userId,
              java.lang.String uboDeclarationId,
              Ubo ubo)
       throws java.lang.Exception

Parameters:

userId - ID of the user

uboDeclarationId - ID of the UboDeclaration

ubo - Ubo

Returns:

Ubo object

Throws:

java.lang.Exception

getUbo

Ubo getUbo(java.lang.String userId,
           java.lang.String uboDeclarationId,
           java.lang.String uboId)
    throws java.lang.Exception

Parameters:

userId - ID of the user

uboDeclarationId - ID of the UboDeclaration

uboId - ID of the Ubo

Returns:

Ubo object

Throws:

java.lang.Exception

submitForValidation

UboDeclaration submitForValidation(java.lang.String userId,
                                   java.lang.String uboDeclarationId)
                            throws java.lang.Exception

Updates an UBO Declaration with the status VALIDATION_ASKED.

Parameters:

userId - ID of the user

Returns:

UboDeclaration instance

Throws:

java.lang.Exception

get

UboDeclaration get(java.lang.String uboDeclarationId)
            throws java.lang.Exception

Throws:

java.lang.Exception